Add a plugin

Add a form plugin to your Nintex Automation Cloud or Nintex Workflow for Office 365 tenant so form designers can use the plugin's custom controls in their forms.

To add a plugin, you must have either:

A Developer or Administrator role in your Nintex Automation Cloud tenant.
The appropriate SharePoint permissions in your Nintex Workflow for Office 365 tenant.

Note: If you want to add this plugin to your Nintex Automation Cloud tenant, ensure Form plugins are enabled in your tenant by your administrator.

Understand uploaded vs. externally hosted plugins

Form plugins can be uploaded directly to your Nintex Automation Cloud tenant or externally hosted in a hosting service. Both allow you to add custom controls to your forms, but there are slight differences in the file requirements and how the plugins will behave when deleted.

	Uploaded plugins	Externally hosted plugins
File limits	Must be a single JavaScript (.js) file less than 5Mb.	Must be a JavaScript (.js) file. No limit on file size.
Plugin location	Hosted in your Nintex Automation Cloud tenant. Any additional assets must be externally hosted with CORS enabled.	Hosted by an external hosting service provider with CORS enabled. If your hosting provider does not allow you to modify CORS, you can use a CDN such as jsdelivr to serve links from GitHub.
When deleted	The plugin will be immediately removed from all published forms. Already published forms that use the plugin will display errors. Forms that were using the deleted plugin must be edited and republished.	The plugin is not removed from published forms. Already published forms that use the plugin are not affected and will continue to use the plugin. You will need to remove the plugin if you want to edit or republish the form.

Uploaded plugins

Externally hosted plugins

File limits

Must be a single JavaScript (.js) file less than 5Mb.

Must be a JavaScript (.js) file. No limit on file size.

Plugin location

Hosted in your Nintex Automation Cloud tenant.

Any additional assets must be externally hosted with CORS enabled.

Hosted by an external hosting service provider with CORS enabled.

If your hosting provider does not allow you to modify CORS, you can use a CDN such as jsdelivr to serve links from GitHub.

When deleted

The plugin will be immediately removed from all published forms. Already published forms that use the plugin will display errors.

Forms that were using the deleted plugin must be edited and republished.

The plugin is not removed from published forms. Already published forms that use the plugin are not affected and will continue to use the plugin.

You will need to remove the plugin if you want to edit or republish the form.

Note: Uploaded plugins are currently only available in Nintex Automation Cloud.

Add a plugin

Click Form plugins in the left navigation.
Click Add plugin.
Select either:
- Upload, and click Select file to choose the plugin file to upload.
- Link a URL and enter the Source URL where you have uploaded your plugin.
In the Element name field, type the name of the exported web component.

This field must exactly match the custom element name in the plugin's source code, including capitalization.

Your plugin element name must contain a hyphen - and must not start with ntx-, nwc-, nac-, or nintex-. These prefixes are reserved to prevent conflicts with Nintex elements. For best practice, use your organization's name as a prefix. For example, acme-custom-textfield.

If you want to add more information to identify the plugin, add a Description.

Nintex Automation Cloud validates your plugin before adding it to your tenant.

Note: If you have added a new version of an externally hosted plugin and want your forms to use the new version, remove the plugin from the form design and configure it again.