Nintex Workflow

The Nintex Workflow connector makes workflows, workflow instances, tasks, and users available for use within app pages. It is pre-configured within environments with Automation Cloud and Apps as a paired tenant set, requiring no setup.

Using the Workflow connector

Workflow objects follow the convention of being detail objects—which typically offer more fields on an individual record—and list objects—which are better equipped for showing only some fields on many records.

To create a model for a Workflow connector object:

  1. Create a new model.
  2. Select Workflow
  3. Set Object to the desired table.

Workflow connector objects can only be used with basic models, not aggregate.

Parameters

Workflow object records are filtered using parameters, with detail objects requiring an Id parameter to retrieve the details of a specific object record.

Required parameters, like the Task (Detail) object’s taskId parameter, are automatically added to the model and must be set, otherwise page errors will occur. Optional parameters may be added individually.

To use a parameter, first add it to an operation:

  1. In the Elements panel, click Models.

  2. Click the model you wish to set parameters for.

  3. Click the Parameters tab.

  4. Beneath the Retrieve operation, click Add parameter. The parameter selection modal appears, listing all available parameters and their descriptions.

    • There is currently no need to set parameters for other operations.
  5. Click Add beside the desired parameters.

  6. Click Done.

With the parameter added to the operation, set a value for the parameter:

  1. Click More Options beside the desired parameters.
  2. Click Configure.
  3. Set the parameter’s value.

For more information about parameters, see the Parameters section in the Model Conditions topic.

If this parameter needs to be controlled dynamically in the page, enable the Control parameter with condition property and reference the controlling condition name.

Dependent models

Some data is stored within arrays. These arrays can be accessed as objects with dependent models. To create dependent models:
  1. Click the model containing the array.

  2. Click the Data tab.

  3. Click Fields.

  4. Click Arrays.

  5. Beside the array you wish to include, click Create dependent model.

For more information about dependent models, see Create and Configure Models

Users (List)

Returns a list of users and user data in the Automation Cloud tenant.

Optional parameters

  • filter: Filter the returned list by name or email address

  • role[]: Filter the returned list by role.

    Allowed values:

    • designer
    • developer
    • participant
    • automationAdmin
    • globalAdmin
  • id[]: Filter the returned list by id

  • email[]: Filter the returned list by email

Task (Detail)

Returns details about a specific task. The taskId parameter must be set.

Arrays

The following arrays can be accessed using dependent models. Nested bullets indicate nested arrays:

  • Outcomes: The outcome of the task—empty until the task is completed
  • Task Assignments: The assigned user of a task
    • Delegates: The task delegates as set by the task assignee

Required parameters

  • taskId: The unique identifier for the task

Specific workflow instances (List)

Returns a list of all instances for a specific workflow. That workflow’s Id must be set as a parameter.

Required parameters

  • workflowId: Unique identifier of the workflow

Optional parameters

  • initiator[]: Filter the list to instances that were started by these initiators. To list multiple initiators, add the parameter multiple times. For example: initiator[]=Anne.Smith@example.com&initiator[]=auth0|000000000000000000000001

  • from: Filter the list to instances that started after this time. Default to the range of the past 30 days if either to or from is not provided

  • to: Filter the list to instances that started before this time. Default to the range of the past 30 days if either to or from is not provided

  • excludeStartEvent: Set to true to include the instance startEvent data from the response payload. Allowed values: false, true

  • name: Filter the list to instances with a custom name containing these words (case insensitive)

  • eventType: Filter the list to instances triggered by this type of workflow start event

  • endDateTimeTo: Filter the list to instances that stopped running before this time. Ignored if either endDateTimeTo or endDateTimeFrom is not provided

  • endDateTimeFrom: Filter the list to instances that stopped running after this time. Ignored if either endDateTimeTo or endDateTimeFrom is not provided

  • status: Filter the list to instances with this status

    Allowed values:

    • Running
    • Completed
    • Failed
    • Terminated
  • $skiptoken: Token to retrieve a specific page of results

Tasks (List)

Returns a list of all tasks in the tenant.

The default value of the status parameter is ‘active’. If you wish to see all tasks, be sure to add this optional parameter to the model and set the desired statuses

Arrays

The following arrays can be accessed using dependent models. Nested bullets indicate nested arrays:

  • Outcomes: The outcome of the task—empty until the task is completed.
  • Task Assignments: The assigned user of a task
    • Delegates: The task delegates as set by the task assignee

Optional parameters

  • from: The start of the date period to retrieve tasks for
  • workflowName: Filter tasks by workflow design name
  • assignee: Filter tasks by assignee email
  • workflowInstanceId: Filter tasks by workflow instances
  • to: The end of the date period to retrieve tasks for
  • status: Return a list of tasks by status. Default value is ‘active’. Allowed values:
    • active
    • expired
    • complete
    • overridden
    • terminated
    • all

All workflow instances (List)

Returns instances for all workflows in the tenant.

Optional parameters

  • workflowName: Filter the list to instances of a workflow with this name.

  • endDateTimeTo: Filter the list to instances that stopped running before this time. Ignored if either endDateTimeTo or endDateTimeFrom is not provided

  • includeDeleted: Set to true to include instances from deleted workflows. Default value is false. Allowed values:

    • true
    • false.
  • $skiptoken: Token to retrieve a specific page of results.

  • status: Filter the list to instances with this status. Allowed values:

    • Running
    • Completed
    • Failed
    • Terminated
  • to: Filter the list to instances that started before this time. Default to the range of the past 30 days if either to or from is not provided

  • endDateTimeFrom: Filter the list to instances that stopped running after this time. Ignored if either endDateTImeTo or endDateTimeFrom is not provided.

  • from: Filter the list to instances that started after this time. Default to the range of the past 30 days if either to or from is not provided

  • eventType: Filter the list to instances triggered by this type of workflow start event.

  • name: Filter the list to instances with a custom name containing these words (case insensitive).

  • initiator[]: Filter the list to instances that were started by these initiators. To list multiple initiators, add the parameter multiple times. For Example: initiator[]=anne.smith@example.com&initiator[]=auth0|0000

  • excludeStartEvent: Set to true to exclude the instance startEvent data from the response payload. Default value is false. Allowed Values:

    • false
    • true.

Published workflows (List)

Returns a list of all published workflows in the tenant.

Arrays

The following arrays can be accessed using dependent models. Nested bullets indicate nested arrays:

  • Event Configuration: Additional workflow event configuration
    • Event configuration values: The configured values of an event configuration
  • Tags: Name and color index of tags attached to this workflow design.

Optional parameters

  • sortBy: Sort the returned list using lastModified or created. Default: lastModified
  • eventType: Filter the list to workflows that use this start event. Start events are formatted as connector:event and are available in the published.eventType.id or draft.eventType.id property of the workflow design. For example, nintex:form or nintex:externalstart.

Connector actions

Create user

Creates a new user in Automation Cloud. The user will be granted access to workflows and other resources based on their assigned role. This action is commonly used when onboarding new team members to the system.

Properties:
  • Content-Type: The content type for the request, typically set to application/json.
  • email: (Required) The email address of the user.
  • firstName: (Required) The first name of the user.
  • lastName: (Required) The last name of the user.
  • role: (Required) The role assigned to the user. Allowed values listed below, which map to the relevant Automation Cloud roles
    • designer
    • developer
    • participant
    • automationAdmin
    • globalAdmin

Complete task

Marks a specific task as completed, updating its outcome within the workflow process.

Properties:
  • assignmentId: (Required) The unique identifier of the task assignment.
  • outcome: (Required) The outcome of the task assignment. Must match one of the task’s defined outcomes (e.g., Approve or Reject).
  • taskId: (Required) The unique identifier of the task.

Start component workflow

Starts the selected workflow in Automation Cloud, creating a new workflow instance. Once started, the instance can be managed in Automation Cloud or manipulated with other actions.

Properties:
  • workflow_id: (Required) The unique identifier of the workflow to run.

Delete workflow instance

Deletes a specific workflow instance. Workflow instances can only be deleted if their status is completed, failed, or terminated.

Properties:
  • instanceId: (Required) The unique identifier of the workflow instance to delete.
  • messageId: (Required) The identifier for the delete operation.

Delegate task assignment

Delegates a task assignment to one or more other users.

Properties:
  • assignmentId: (Required) The unique identifier of the task assignment.
  • delegates: (Required) A comma- or semicolon-separated list of email addresses for the delegate(s).
  • message: An optional message explaining the reason for delegation.
  • taskId: (Required) The unique identifier of the task.

Stop workflow instance

Stops an active workflow instance.

Properties:
  • instance_id: (Required) The unique identifier of the workflow instance to terminate.

  • reason: An optional reason for stopping the workflow.