Property description

The workflowTransitionTriggers asset defines custom triggers (scripts) that are executed upon a workflow state change.

Tip

You can also configure triggers as in-place configuration, meaning part of a workflow configuration. For more information, see triggers.

Minimal JSON

{
  "workflowKey":"",
  "fromStateKey":"",
  "toStateKey":"",
  "changeUserRelationTypeKey":"",
  "orderNumber":
}
{
  "workflowKey": "cust_example_app_workflow",
  "fromStateKey": "cust_example_app_approved",
  "toStateKey": "cust_example_app_draft",
  "changeUserRelationTypeKey": "cust_example_app_contributor",
  "orderNumber": 1000,
  "type": "to_current_user"
}

Nested properties

Properties

PropertyDescriptionValuesMandatory
workflowKeyKey of the workflow the triggers are assigned to.stringYes
fromStateKeyKey of the workflow state where a transition begins.stringYes
toStateKeyKey of the workflow state where a transition ends.stringYes
changeUserRelationTypeKeyKey of the user relation type changed during the workflow state transition.stringYes
orderNumberOrder of the triggers.integerYes
changeToValueUserRelationTypeKeyKey of the new user relation type which value(s) will replace those in changeUserRelationType.stringNo
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 that made the change.select_user_from_allowed: Similarly to default, but a user is selected during the transition.stringNo