| Import Cloudmersive Document Conversion API as Nintex Xtension via OpenAPI Spec |
| 1/12/2026 - Cloudmersive Support |
Prerequisites
- You must have a Nintex role that can manage Xtensions (Nintex notes a developer or administrator role is required).
- You must have a Cloudmersive API key for the Convert API. Cloudmersive uses an API key sent in an HTTP header named
Apikey.
Part 1 — Import Cloudmersive Convert Swagger as an Xtension (OpenAPI connector)
A) Open the Xtensions area
- Sign in to Nintex Automation Cloud.
- Go to Workflows.
- Click Xtensions.
B) Start the OpenAPI import (by URL)
- In the Custom connector list, click the Add / + control (or the add button in the list).
- Choose OpenAPI Specification via file upload or URL.
- Select the URL option (if prompted).
- Paste this URL (exactly):
https://api.cloudmersive.com/convert/docs/v1/swagger
- Click Next and wait for Nintex to validate the specification.
C) Confirm authentication type is API key (detected from the spec)
- Nintex should detect the API key security definition from the Swagger/OpenAPI spec. (Nintex uses “security templates” based on what’s defined in the spec.)
D) Name and publish the Xtension
- Set a clear name, e.g. Cloudmersive Convert API (this becomes the action group name in the workflow designer).
- Optionally set a description and icon.
- Click Publish.
Part 2 — Use the Cloudmersive Xtension in a Nintex workflow
A) Create (or open) a workflow
- Go to Workflows → Create workflow (or open an existing workflow).
B) Add a Cloudmersive action
- In the workflow designer, open the Actions panel.
- Find your new action group (it will be named whatever you published, e.g. Cloudmersive Convert API).
- Drag the desired Convert action into the workflow (for example, a “Convert to PDF” type operation).
C) Create the connection (enter your Cloudmersive API key)
-
Click the Cloudmersive action you added.
-
In the action configuration panel, choose Add new connection (or Create connection).
-
When prompted for the API key, enter your Cloudmersive Convert API key.
- Cloudmersive expects the key to be sent as header:
Apikey: <YOUR_KEY>.
-
Save the connection.
D) Configure inputs/outputs and test
- Map the action inputs (file content, URL, or other required parameters depending on the specific Convert operation).
- Run a test instance of the workflow and confirm the output (e.g., converted file) is returned.
Common gotchas
- If the connector import fails, it’s usually because the OpenAPI format/auth definition isn’t compatible. Nintex’s Xtensions OpenAPI path relies on what’s defined in
securityDefinitions for API key auth.
- Make sure you’re using the exact Swagger URL above and that you have a valid Cloudmersive API key.
|