Triggers

Contents:

Overview

A workflow trigger adds flexibility and automation to your documentation process. When triggered, it can perform one or more actions automatically, like changing the state, completing an approval, sending a custom email, or removing Confluence page restrictions.

Examples of workflow triggers:

• Send a notification when a page is submitted for review.

• Change the page state automatically when it's edited.

• Assign reviewers when a page enters a specific state.

• Add a label or comment when a transition occurs.

Triggers can be configured to:

• Listen for when a single workflow event occurs

• Check if the required conditions are met for the event

• If met, then undertake one or more actions

Trigger elements

Workflow triggers consist of the following elements:

Trigger events

Trigger conditions

Trigger actions

Adding a trigger to a workflow

A space administrator can add one or more workflow triggers to a custom workflow using either the visual editor or the code editor.

• Use the Add trigger dialog box in the visual editor.

Open

Visual editor - Add trigger editor

The event and condition are chosen from a drop-down list of available options.

You can then include one or more Actions for the trigger using the Add Action option, such as the Set Message action.

Open

Visual editor - Add Action dialog box in the trigger editor

The added trigger is automatically updated in the code editor.

Open

Code editor - send email trigger

You can also add a workflow trigger in the code editor, which includes a JSON schema to help you.

Open

You can toggle between the code editor and the visual editor. Changes made in one editor are automatically updated in the other editor.

The workflow triggers added to a workflow are listed in the visual builder.

Open