triggers (workflow transition)

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.

{
  "changeUserRelationTypeKey": ""
}

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

Property	Description	Values	Mandatory
`changeUserRelationTypeKey`	Key of the user relation type changed during the workflow state transition.	string	Yes
`changeToValueUserRelationTypeKey`	Key of the new user relation type which value(s) will replace those in `changeUserRelationType`.	string	No
`orderNumber`	Execution order or the triggers.	number	No
`pipelineKey`	Key of the pipeline triggered by the transition.	string	No
`type`	Defines an action type performed during the workflow state transition. See supported `type` values.	string	No

Value	Description
`default`	Changes the value of `changeUserRelationType` based on the value of `changeToUserRelationType`. If `changeToUserRelationType` is `NULL`, `changeUserRelationType` is also set to `NULL` during the transition.
`select_user_from_allowed`	Similar to `default`, but a user is selected during the transition.
`to_current_user`	Changes the value of `changeUserRelationType` to the current user, i.e. the user who changed the workflow state.