Expand all   Collapse all

Overview


A trigger can be set to listen for a named event in the workflow. When the workflow event occurs the trigger will check that any required conditions are met, and if met set one or more actions.

Event

A trigger can be set to listen for the following events:

A workflow JSON trigger can include more than one event.

However, only one of each type of event can be included in a single trigger.

The trigger event can be filtered to a specific occurrence using conditions.

Once the event occurs and any conditions are met the trigger actions occur.

Related Pages

Example on-expire event

"triggers":
[
	{"event": "on-expire",
  	"conditions":
	[
		{"final":true}
	],
  	"actions":
	[
		{"action": "change-state",
			"state": "Review"},
		{"action": "set-message",
        	"type": "info",
            "title": "Stale content",
            "body": "Content may be out of date",
            "tags": "state",
            "mode": "autoClose"}
    ]}
]

(info) If adding the JSON trigger using workflow builder there is no need to include the opening "triggers": JSON markup notation, since it will be added by workflow builder.

Each event includes

If a JSON condition is present this can include one or more conditions. The trigger will only allow the event to be valid if these conditions are valid.

  • in the example above, the on-expire event is only listening for that workflow expiry event for the final state

The JSON trigger event must include at least one JSON trigger action.

If you want to add this trigger to a workflow you can copy and paste the JSON code format (without the opening "triggers": JSON markup notation) to the Triggers dialog in the Edit Workflow panel in workflow builder.


Or you can also add this JSON notation directly to the workflow using the JSON Editor (but you need to include the opening "triggers": JSON markup notation).