Overview
...
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
Overview
A workflow trigger creates a more flexible and responsive workflow, adding custom automation to your documentation process.
When a set selected event or action occurs, such as the assignment of assigning a reviewer or a change of changing the workflow state, you can use a workflow trigger to undertake one or more actions, such as a change of changing the state or completing an approval.
One or more workflow triggers can be added to a workflow. Each workflow trigger is set to
...
listen for a single workflow event, such as a change of state ("on-change-state" event)
...
a custom
...
Triggers are added to a workflow as JSON code. They can be added using workflow builder or the code editor.
| Info |
|---|
JSON Triggers are used to create a more flexible and responsive workflow. |
Example
...
In the example belowabove:
the workflow trigger listens for a change of state
the set condition constrains the workflow trigger to listen for the state change to the Rejected state
once this event occurs, the workflow trigger actions a change of state back an immediate transition to the Draft state
o.png?version=1&modificationDate=1734628374103&cacheVersion=1&api=v2&width=650)
| Info |
|---|
If the JSON trigger is added using the workflow builder, there is no need to include the "triggers": JSON element. The workflow builder adds this automatically. |
...
, ready to be updated by your editors
A trigger can be set to listen . These include
...
approval event
...
a reviewer assignment or unassignment event
...
to one of a range of workflow events, including approval, reviewer assignment, and change of state events.
You can constrain the events by adding conditionsadding a condition for the event, such as a named state in the workflow
...
the final state
...
the initial transition to a named state
Trigger actions include
changing the state
assign or unassign a Confluence user or Confluence groups as reviewers to an approval
approve or reject an approval
set a state expiration due date period
create a custom notification, such as an email or on-screen message
remove page-level user permissions†
.
One or more trigger actions can be added for a trigger. These actions include changing the state, sending a custom email, or removing page-level Confluence restrictions.†
Adding a trigger
A space administrator can add one or more triggers to a custom workflow using the visual editor.
...
Triggers added to a workflow are shown in the workflow panel in the visual editor.
...
You can also add a trigger to a workflow using the code editor.
† Only 'Confluence Cloud Standard, Premium, and Enterprise Plans' enable customers to edit permissions, including global, space, and page permissions