null


Skip to end of banner
Go to start of banner

JSON Trigger conditions

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

Overview

One or more conditions can be set for a trigger for a named event in the workflow.When the named workflow event occurs the trigger checks that any required condition is met, and if met sets one or more actions.

Conditions

condition must be met for the trigger to perform the specified action(s). Available conditions are

  • "state": "(string value)"

  • "final":(boolean true/false)

  • "initial": (boolean true/false)

If "final" condition is added together with another condition to an event, the condition is evaluated as an OR function.

The "initial" condition can be constrained to a named state in the workflow using the "state" condition.

Boolean condition values true and false are added WITHOUT encompassing quotation marks, for example "final":true or "final":false

JSON trigger conditions


Example “on-change-state" event

"triggers":
[
    {"event": "on-change-state",
    "conditions":
    [
        {"final":true}
    ],
    "actions":
    [
        {"action": "clean-messages"}
    ]}
]

If adding the JSON trigger using workflow builder visual builder there is no need to include the opening "triggers": JSON markup notation, it is added automatically by workflow builder.

The trigger action clears any existing messages on the content

  • "actions":[{ "action":"clean-messages"}],

The messages are only cleared on the change of state to the final state in the workflow

  • "conditions": [{"final": true}],

Example “on-approve" event

"triggers":
[
	{"event": "on-approve",
	"conditions":
	[
		{"state":"Review"}
	],
	"actions":
	[
		{"action":"change-state",
			"state":"Published"}
	]}
]

If adding the JSON trigger using workflow builder visual builder there is no need to include the opening "triggers": JSON markup notation, it is added automatically by workflow builder.

The trigger action causes a change of state

  • "actions":[{ "action":"change-state"}],

The trigger action occurs on the approve event but ONLY if the current state is the Review state

  • "conditions":[{"state":"Review"}],

If a JSON condition is present this can include one or more conditions but only ONE state condition can be used for each event.


  • No labels