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": 0
}{
"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
| Property | Description | Values | Mandatory |
|---|---|---|---|
workflowKey | Key of the workflow the triggers are assigned to. | string | Yes |
fromStateKey | Key of the workflow state where a transition begins. | string | Yes |
toStateKey | Key of the workflow state where a transition ends. | string | Yes |
changeUserRelationTypeKey | Key of the user relation type changed during the workflow state transition. | string | Yes |
orderNumber | Order of the triggers. | integer | Yes |
changeToValueUserRelationTypeKey | Key of the new user relation type which value(s) will replace those in changeUserRelationType. | string | 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 |
Supported type values
| 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 made the change. |