Overview | Triggers | Example | Related pages
Overview
You can use workflow triggers to help automate your documentation process and flexibly respond to workflow events.
For example, you can use a trigger to automatically send an email when a page is submitted for review.
Triggers can be added to
listen for workflow
eventscheck for a set condition or
conditionsto be met for each eventset one or more
actionsfor each event
A custom workflow can include one or more workflow triggers. A workflow trigger is added as JSON code using the workflow builder or the JSON editor
.
Triggers
A JSON trigger contains three different
elements:
| Filter by label (Content by label) | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Multiple triggers can be added to a workflow. A trigger for an event must include at least one or more actions.
JSON trigger events | JSON trigger conditions | JSON trigger actions | ||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
|
You Using the workflow builder visual editor, you can add the trigger JSON code to your custom workflow using workflow builder.
Example
In a 4-state workflow, you might want the workflow to move immediately from a Rejected state to a more proactively named Triage state rather than waiting for a user to manually transition the content.
You can use a trigger to listen for the state change event to the Rejected state and set the trigger action to immediately transition to the Triage state.
The trigger is created using JSON code.
| Code Block |
|---|
"triggers":
[
{"event":"on-change-state",
"conditions":
[
{"state":"Rejected"}
],
"actions":
[
{"action":"change-state",
"state":"Triage"}
]}
] |
| Info |
|---|
If you want to add this trigger to a workflow using Workflow Builderthe workflow builder visual editor, copy and paste the JSON code format (without the opening |
There are a number of workflow events that can be added to a trigger. For each trigger, you can set one or more conditions, for example, to constrain a trigger to listen for an event that occurs in a particular state. One or more actions can be added to a workflow trigger that is undertaken when the event takes placeoccurs.
Each trigger action can have a number of mandatory elements parameters and optional elements parameters depending on the action.
Related pages
Triggers
| Child pages (Children Display) |
|---|
Using Workflow Builder