ZenQMS Connector

Connections

ZenQMS API Connection

Input	Comments	Default
ZenQMS Environment	Select the ZenQMS environment you would like to connect to.
ZenQMS API Key	Generate this token under your Settings => API Settings. For audit trail, it is recommended to create a new token for each integration.

Triggers

New and Updated Document Versions

Triggers when a document version is created or updated

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Optional Lucene query to filter document versions (e.g., category_version_id:"abc"). Combined with the cursor range filter using AND.

New and Updated Items

Triggers when an item is created or updated

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Optional Lucene query to filter items (e.g., category_id:"abc" or external_system:"salesforce"). Combined with the cursor range filter using AND.

Actions

Add Roles to User

Assigns one or more roles to a user

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
User ID	The user UUID
Role IDs	Array of role UUIDs in JSON format

Add Users to Role

Assigns one or more users to a role

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Role ID	The role UUID
User IDs	Array of user UUIDs in JSON format

Cleanup Users External IDs

Removes external IDs from users that have them

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action

Create Document Version

Creates a new document version

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Category ID	The document category UUID
Name	The document version name
Due Date	Approval due date in YYYY-MM-DD format
Is Training	Whether this is a training document	false
Authors	JSON array of author user UUIDs

Create Item

Creates a new item

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Category ID	The item category UUID
Title	The item title
Due Date	Due date in YYYY-MM-DD format
External ID	External identifier in the source system
External System	Name of the external system (e.g. salesforce)
External URL	URL linking to the item in the external system.
Assignees	JSON array of user UUIDs to assign to the item
Stage Assignees	JSON array of user UUIDs to assign at the stage level
Custom Fields	JSON array of custom field objects with api_name and value

Create User

Creates a new user

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
External ID	External identifier in the source system
First Name	User's first name
Last Name	User's last name
Email	User's email address
Title	User's job title
Is Active	Whether the user is active	false

Get Item by External ID

Retrieves an item by external ID

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
External ID	External identifier in the source system
External System	Name of the external system (e.g. salesforce)

Get Item Stages by Category

Retrieves stage definitions and their custom fields for a given category

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Category ID	The category UUID to retrieve stages for

Get User By Email

Retrieves a user by email

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Email	User's email address

Get User By External ID

Retrieves a user by external ID

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
External ID	External identifier in the source system

List Custom Field Options

List custom field options with optional filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Custom Field ID	The UUID of the custom field to retrieve options for
Search	Search term for custom field options (Lucene query syntax). Searchable fields: option, created_at, updated_at
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

List Custom Fields

List custom fields with optional filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Search term for custom fields (Lucene query syntax). Searchable fields: created_at, updated_at, is_required, is_account, is_user, label, description, api_name (default), type
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

List Document Categories

List document categories with optional filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Search term for document categories (Lucene query syntax)
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

List Document Versions

List document versions with optional filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Search term for document versions (Lucene query syntax)
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

List Items

List items with optional filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Generic search term (e.g., title:"Report" or external_id:"123")
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

List Roles

Retrieve a paginated list of roles with optional search filtering

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Search	Generic search term (e.g., name:"Admin" or user_id:"123")
Get All Results	When enabled, automatically fetches all pages and returns all results. Ignores currentPage parameter.	false
Page Size	Number of results per page (default: 50)	50
Current Page	Page number to retrieve (default: 1)	1
Sort By	Field name to sort results by
Order By	Sort order (asc or desc)

Raw Request

Send a raw HTTP request

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
URL	Input the path only (e.g., /v2/users). The base URL is already included from the connection.
Method	The HTTP method to use.
Data	The HTTP body payload to send to the URL.
Form Data	The Form Data to be sent as a multipart form upload.
Query Parameter	A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
Header	A list of headers to send with the request.
Response Type	The type of data you expect in the response. You can request json, text, or binary data.	json
Timeout	The maximum time that a client will await a response to its request
Debug Request	Enabling this flag will log out the current request.	false
Retry Delay (ms)	The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.	0
Retry On All Errors	If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.	false
Max Retry Count	The maximum number of retries to attempt. Specify 0 for no retries.	0
Use Exponential Backoff	Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.	false

Remove Roles from User

Removes one or more roles from a user

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
User ID	The user UUID
Role IDs	Array of role UUIDs in JSON format

Remove Users from Role

Removes one or more users from a role

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Role ID	The role UUID
User IDs	Array of user UUIDs in JSON format

Update Item

Updates an existing item

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
Item ID	The item UUID to update
Stages	JSON array of stage objects with id and custom_fields

Update User

Updates a user

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
External ID	External identifier in the source system
First Name	User's first name
Last Name	User's last name
Email	User's email address
Title	User's job title
Is Active	Whether the user is active	false

Upsert User

Creates or updates a user

Input	Comments	Default
ZenQMS API Connection	The API connection to use for this action
External ID	External identifier in the source system
First Name	User's first name
Last Name	User's last name
Email	User's email address
Title	User's job title
Is Active	Whether the user is active	false

Connections​

ZenQMS API Connection​

Triggers​

New and Updated Document Versions​

New and Updated Items​

Actions​

Add Roles to User​

Add Users to Role​

Cleanup Users External IDs​

Create Document Version​

Create Item​

Create User​

Get Item by External ID​

Get Item Stages by Category​

Get User By Email​

Get User By External ID​

List Custom Field Options​

List Custom Fields​

List Document Categories​

List Document Versions​

List Items​

List Roles​

Raw Request​

Remove Roles from User​

Remove Users from Role​

Update Item​

Update User​

Upsert User​