JSON Triggers

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 events
check for a set condition or conditions to be met for each event
set one or more actions for 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:

https://fast.wistia.com/embed/medias/6i0w099qi7.jsonp

Multiple triggers can be added to a workflow. A trigger for an event must include at least one or more actions.

Workflow trigger events	Workflow trigger conditions	Workflow trigger actions

Workflow trigger events	Workflow trigger conditions	Workflow trigger actions
Page: on-assign event Page: on-change-state event Page: on-unassign event Page: on-approve event Page: on-expire event Page: on-reject event	Page: final condition Page: initial condition Page: state condition	Page: approve trigger action Page: assign trigger action Page: change-state trigger action Page: clean-messages trigger action Page: clear-expiration trigger action Page: publish-page trigger action Page: reject trigger action Page: remove-restrictions trigger action Page: send-email trigger action Page: set-expiration trigger action Page: set-message trigger action Page: unassign trigger action

You can add a workflow trigger using the code editor

The code editor includes

color coding to easily distinguish property names, values, and different data types
autocomplete features
dropdown selectors for workflow trigger events, conditions, and action properties

code validation

Or add the trigger JSON code directly to your workflow using the visual editor.

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

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.

"triggers":
[
	{"event":"on-change-state",
	"conditions":
	[
		{"state":"Rejected"}
	],
	"actions":
	[
		{"action":"change-state",
			"state":"Triage"}
	]}
]

If you want 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 code) to the Triggers dialog in the Edit Workflow panel in the editor.

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 undertaken when the event occurs.

Each trigger action can have a number of mandatory parameters and optional parameters depending on the action.

Related pages

Triggers

Using Workflow Builder

Add a JSON trigger using workflow builder