Skip to main content

Platform SDK

The Platform SDK provides tools to build custom plugins for Alteryx Designer. It is a superset that includes both new and legacy SDKs and offers additional methods to extend Alteryx products. The development kit includes:

Platform SDK Tools

  • AYX Plugin CLI: The primary tool to scaffold, build, and package Alteryx Designer plugins. The CLI automates workspace generation for both the Python backend and React-based UI front end, reducing manual setup to a single command. It also handles YXI packaging for distribution and installation into Designer.

  • AYX UI SDK: The React-based framework (@ayx/react-comms) for building plugin configuration panels and other user interfaces in Designer.

  • AYX Python SDK (v2): The v2 Python backend framework for implementing custom plugin data processing logic with Python scripting. Used alongside the AYX UI SDK to create custom plugins for Designer.

Requirements

To start building plugins with the AYX Plugin CLI, you need these items installed on your machine:

  • Microsoft Windows 10 or later (64-bit): Go to System Requirements for your Designer version.

  • Designer version 2021.2 is the minimum required version, though we recommend a supported Alteryx Designer version. For details on which Designer versions are currently supported, go to Version Support Policy.

  • Minimum Python Version 3.85 (review Alteryx Embedded Python to learn which Python version is compatible with each Alteryx release).

  • pip (automatically installed with Python 3.85)

SDK Quickstart Guide

Visit the Platform SDK Quickstart Guide to learn how to use the latest developer tools to create a custom plugin for use in Alteryx. The guide includes a step-by-step onboarding walkthrough for developers new to the Platform SDK. It covers the initial setup and workflow required to author a custom plugin.

Legacy SDKs

Older SDKs remain available for backward compatibility. They are the HTML GUI SDK, the C++ Engine SDK, the Python Engine SDK (v1), and the Connect Loader SDK. For new plugins, use the tools listed above. To find the older SDKs, go to Legacy SDKs.