Property description

The triggers property configures custom scripts that are executed when a workflow state transition happens.

Tip

This is an in-place configuration, meaning all of the following must be configured in the package: workflow, transitions, and triggers.

To configure triggers in a separate package to reuse later, see workflow transition triggers.

Minimal JSON

{
  "changeUserRelationTypeKey": ""
}
{
  "name": "Draft",
  "triggers": [
    {
      "changeUserRelationTypeKey": "assigned_to",
      "type": "to_current_user"
    }
  ]
}

Nested properties

Properties

PropertyDescriptionValuesMandatory
changeUserRelationTypeKeyKey of the user relation type changed during the workflow state transition.stringYes
changeToValueUserRelationTypeKeyKey of the new user relation type which value(s) will replace those in changeUserRelationType.stringNo
orderNumberExecution order or the triggers.numberNo
pipelineKeyKey of the pipeline triggered by the transition.stringNo
typeDefines an action type performed during the workflow state transition. Supported values are:default: Changes the value of changeUserRelationType based on the value of changeToUserRelationType.If the changeToUserRelationType is NULL, then during the transition the value of changeUserRelationType will also be set to NULL.to_current_user: Changes the value of changeUserRelationType to the current user, i.e. user who changed the workflow state.select_user_from_allowed: Similar to default, but a user is selected during the transition.stringNo