change-state trigger action

1 Overview | 2 "change-state" | 2.1 ❗️ Mandatory parameter | 2.2 Example trigger code | 3 Related pages

Overview

You can use the change-state action in a trigger to change the workflow state automatically. For example, it can be used in an on-reject event trigger to fast-track a single rejected decision when multiple reviewers are assigned to an approval.

When the workflow trigger event occurs, the trigger checks that any required conditions are met, and if they are met, the "change-state" action forces a change of the state.

`"change-state"`

The trigger action "change-state" causes the state to change to the specified state if the provided parameters are valid.

action (change-state)
- state❗️ destination workflow state for the action
  - state must be a state in the workflow
  - state names are case-sensitive

❗️ Mandatory parameter

state parameter

state parameter must be included with a valid value for the destination state

Example trigger code

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"final":true}
	],
	"actions":
	[
		{"action": "change-state",
			"state": "Archive"}
	]}
]

The example trigger listens for the workflow's change of state to the final state and immediately moves the workflow to the Archive state.

The destination state must be included in the "change-state" action.

Another use of the trigger action is to move from the workflow Review state, which contains an approval, immediately on a reviewer rejection, to the Editing state. This can be used to fast-track a single rejected decision, for example, when multiple reviewers are assigned to an approval.

"triggers":
[
	{"event": "on-reject",
	"conditions":
	[
		{"state":"Review"}
	],
	"actions":
	[
		{"action": "change-state",
			"state": "Editing"}
	]}
]