Triggers

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 when a single workflow event occurs

• check if the required conditions are met for the event

• if met, then undertake one or more actions

Open

_{Workflow trigger events, conditions, and actions}

Triggers

Workflow triggers consist of the following elements:

Multiple triggers can be added to a workflow. A trigger for an event must include at least one or more 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 dropdown 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 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

Related pages

• Add a workflow trigger using the visual editor

• Add workflow trigger using the code editor