Event
A trigger can be set to listen for the following events.
A workflow JSON trigger can include more than one "event".
However, only one of each type of event can be included in a single "event" in the trigger.
For example,
{"event": "on-change-state", "actions":[............]}
The trigger event is filtered to a specific occurrence using conditions.
For example, the event has a condition to only listen for a change of state to a named state
{"event": "on-change-state","conditions":[{"state":"Approved"}], "actions":[............]}
Once the event occurs and any conditions are met, and one or more set trigger actions occur.
Example "on-expire" event
"triggers":
[
{"event": "on-expire",
"actions":
[
{"action": "change-state",
"state": "Review"},
{"action": "set-message",
"type": "warning",
"title": "Stale content",
"body": "Content has passed its set life and may be out of date",
"tags": "state",
"mode": "autoClose"}
]}
]
If adding the JSON trigger using workflow builder visual editor there is no need to include the opening "triggers": JSON markup notation, it is added automatically by workflow builder.
The on-expire event only listens for a workflow expiry event.
Each event can include
one or more actions
The JSON trigger event must include at least one JSON trigger action.
There are two actions in the above example
the
"change-state"action to transition the workflow to the Review state and"set-message"notification action
If a JSON trigger action is present this can include one or more conditions. If no conditions are added - the trigger listens for an expiration event for any state.
To add this trigger to a workflow using the workflow builder visual editor, copy and paste the JSON code format (without the opening "triggers": JSON markup notation) to the Triggers dialog box in the Edit Workflow panel in workflow builder.
