We are updating the requirements for Community registration. As of 7/21/21 all users will be required to register a phone number with their My Alteryx accounts. If you have already registered, you will be prompted on your next login to add your phone number.

Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!
SOLVED

HTML/Javascript SDK Documentation

francic3
6 - Meteoroid

I have read the following article. https://inspiringingenuity.net/2015/12/03/htmlsdk/.  I have pulled apart several plugins in that are already installed on my machine.  But I am about at the end of what I can self discover.

Where can I find actual, in-depth documentation for building HTML/Javascript SDK plugins?

10 REPLIES 10
RachelW
Alteryx Alumni (Retired)

@francic3 We're currently working on fleshing out the HTML/JavaScript SDK, including in-depth documentation. We'll be sure to share more about the SDK as we get closer to releasing it. 

Rachel Wynn
Product Manager - Designer
amarrero45
6 - Meteoroid

hi is the SDK documentation released now?

RachelW
Alteryx Alumni (Retired)

Not yet. Stay tuned! 

Rachel Wynn
Product Manager - Designer
amarrero45
6 - Meteoroid

I know I want to inspire and attend the SDK session.  Is there any other SDK and API documentation that I can read?

RachelW
Alteryx Alumni (Retired)

@amarrero45 I don't have any other formal documentation to share right now. Can you tell me a little more about what you are working on? Perhaps I can point you to some other resources that can help. 

Rachel Wynn
Product Manager - Designer
amarrero45
6 - Meteoroid

@rachelW,  I saw in inspire about an office plugin that connects to alteryx.   I would love to read more on how to do that in excel.

JPKa
Alteryx Alumni (Retired)

@amarrero45

 

What it sounds like you're actually looking for is documentation for our Gallery API.  

 

That's how we've gone about prototypes where we create an Excel plugin that runs and fetches data from Alteryx Analytic apps hosted on a Gallery.  

 

Here's a blog post I wrote last year that contains detailed information on using the Gallery API with Python.  While this isn't showing how to build an Excel plugin, it will go over what you need to know to build your own plugin in the language of your choice.  

 

https://community.alteryx.com/t5/Engine-Works-Blog/Pumpkins-Pythons-and-Platforms-Candy-Sales-Analys...

 

Hope this helps.  

 

Thanks,

 

JP

JP Kabler
Lead Software Engineer, Assisted Modeling
Alteryx
amarrero45
6 - Meteoroid

@JPKa, 

 

thank you so much for the info.  

jdunkerley79
16 - Nebula
16 - Nebula

Started with the UI side but am blogging what I understand of the HTML/JS SDK.

 

https://jdunkerley.co.uk/2017/07/03/beyond-alteryx-macros-alteryxs-javascript-sdk-an-unofficial-guid...

 

Have the TypeScript type definitions for both engine and UI side written as well.

 

James