Nintex Xtensions help documentation
Nintex Xtensions is an extensibility framework for Nintex Automation Cloud, allowing you to create Xtensions A set of instructions for Nintex Automation Cloud to use third-party API functionality with Nintex workflows. An Xtension may include workflow actions, start events, forms or file control. to connect to third-party platforms in your workflows A method of streamlining manual and paper-based processes often comprised of unstructured tasks involving people, processes, and content.. By defining an OpenAPI Specification A standard, language-agnostic description of RESTful APIs that can be read by both humans and machines. Formerly known as Swagger. in JSON JavaScript Object Notation: a data format based on JavaScript that is commonly used for API request parameters and responses., you can automate actions A task that can be performed or triggered within a workflow, such as moving a file, sending an email, or using third-party API functionality. in third-party platforms and services, connecting them with your business workflows.
Use plug-and-play components to build your Xtensions.
Add username and password Identifying the API requestor using a username and password passed in the HTTP header., API key An authorization code passed in an API request, either inside the header or as a parameter, to identify the requester. or OAuth 2.0 A two-step authorization protocol that both identifies the requestor, and allows a user to grant access to a third-party account without revealing their credentials to the requesting software. authentication to your Xtension.
Create drop-down fields A field representing the parameter or response of the endpoint when it is configured as a workflow action in the Workflow Designer., dynamic selections, hidden fields and more with Specification Extensions A Nintex-specific OpenAPI Specification key that allows special functionality within Nintex Xtensions..
Send files to and from your workflow via streaming, URL reference and base64 encoding.

Explore and download example Xtensions from the gallery to help build your processes faster.

Create your first Xtension with Nintex Xtensions, even if you've never coded before:
- Step 1: Find a suitable API
- Step 2: Build the basic structure
- Step 3: Define the operations
- Step 4: Define the parameters
- Step 5: Define the responses
- Step 6: Streamline with references
- Step 7: Import the OpenAPI Specification

Download an example Xtension or build it yourself using one of our tutorials.
![]() |
Create a basic Xtension with no authentication to sanitize profanity from text using PurgoMalum, and create a work-safe customer suggestion box. |
No authentication |
|
![]() |
Create a new GitHub repository and post an issue using Basic authentication Identifying the API requestor using a username and password passed in the HTTP header..
|
Basic authentication (username and password) |
|
![]() |
Use API key authentication An authorization code passed in an API request, either inside the header or as a parameter, to identify the requester. to convert currency and create an automatic international purchase approval workflow. |
API key authentication |
|
![]() |
Use OAuth2 authentication A two-step authorization protocol that both identifies the requestor, and allows a user to grant access to a third-party account without revealing their credentials to the requesting software. to create a new task list in the Google Tasks of the connected user. |
OAuth2 authentication |
|
![]() |
Integrate with an on-premises installation of SAP Theobald yunIO via Nintex Gateway. |
Nintex Gateway | |
![]() |
Rename custom actions and configuration fields with the summarySpecification Extension. A Nintex-specific OpenAPI Specification key that allows special functionality within Nintex Xtensions. |
summary |
|
![]() |
Populate a drop-down configuration field with a list of the designer's Google Tasks tasklists using the dynamic-values Specification Extension. |
dynamic-values |
|
![]() |
Streamline your Workflow designer by concealing unnecessary operations A single request to a third-party API. Operations often become actions in the workflow designer. and configuration fields with the visibility Specification Extension. |
visibility |
|
![]() |
Use the dynamic-schema Specification Extension to dynamically generate a parameter's data structure from the API using a helper operation A single request to a third-party API. Operations often become actions in the workflow designer., to support operations whose parameters may change at runtime. Note: Nintex Automation Cloud provides SharePoint Online actions out-of-the-box. This example is provided for demonstrative purposes only. |
dynamic-schema | |
![]() |
Use the query-builder Specification Extension to create an OData query from a hard-coded or dynamically-generated set of fields. Note: Nintex Automation Cloud provides SharePoint Online actions out-of-the-box. This example is provided for demonstrative purposes only. |
query-builder | |
![]() |
Convert a Nintex Automation Cloud workflow into a custom connector to be used as an action inside other workflows. |
Component workflow |
|
![]() |
Validate input from a configuration field using regular expressions A seqence of symbols used to identify a particular pattern or piece of text within a larger body of text. Often used to validate input, such as valid URLs or email addresses. before sending it to your API. |
Regular expressions (validate) |
|
![]() |
Convert an XML response into JSON JavaScript Object Notation: a data format based on JavaScript that is commonly used for API request parameters and responses. to send a motivating word-of-the-day message to your team on Slack. |
XML response (serverless functions) |
|
![]() |
Pre-process parameters A piece of information passed to a third-party API during a request. from Nintex Automation Cloud into an API's required format to send an email from an external email server within a workflow. |
Pre-process parameters(serverless functions) |
|
![]() |
Assess the opportunity cost of business proposals with WolframAlpha to automate their initial approval process. |
Regular expressions (extract) |
|
![]() |
Add qualified prospects to your company mailing list with Mailchimp. |
||
![]() |
Upload a file to a new task in Asana using file streaming. |
Streaming files (upload) |
|
![]() |
Upload a file into a GitHub repository using base64 encoding. |
Base64 files (upload) |
|
![]() |
Upload a file to Flowdock by passing a file URL reference. |
File reference (upload) |
|
![]() |
Download a welcome pack to send with a file URL reference. |
File reference (download) |
|
![]() |
Download the documentation from a GitHub repository with base64 encoding. |
Base64 files (download) |
|
![]() |
Use Nintex Gateway to create a custom on-premises connector in Nintex Automation Cloud. |
Nintex Gateway |
Also see...
Examples created by third-party services, such as Theobald Software's SAP integration using ECS Core and Theobald software SAP integration using yunIO.
Xtensions solutions you can import into your Nintex Automation Cloud tenant in the Nintex Solution Accelerator Gallery.

If the third-party platform you want to connect to has created an OpenAPI Specification you can adapt it to create your Xtension: