Trigger events

 

Overview

A trigger can be set to listen for a named event in the workflow. 

When the workflow "event" occurs the trigger checks that any required "conditions" are met.

If the set conditions are met for the named event, one or more trigger "actions" occur.

 

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 "event" in the trigger.

For example,

  • {"event": "on-change-state", "actions":[............]}

The trigger event is filtered to a specific occurrence using conditions.

For example, the event has a condition to only listen for a change of state to a named state

  • {"event": "on-change-state","conditions":[{"state":"Approved"}], "actions":[............]}

Once the event occurs and any conditions are met, and one or more set trigger actions occur.

Example "on-expire" event

on-expire event



The trigger can be added to a custom workflow using the code editor.

cdmc_codeeditor_savedtrigger_message.png

The code editor includes

  • color coding to easily distinguish property names, values, and different data types

  • autocomplete feature

  • dropdown selectors for available property names, including workflow trigger events, conditions, and actions

cdmc_code_editor_jsonschema_help_triggers_event.png

The code editor includes a dropdown schema option for the available events.

You can also add the trigger using the visual editor.

You can write the workflow trigger or copy and paste the existing JSON code for a trigger (without the opening "triggers": JSON notation) to the Triggers dialog box in the Edit Workflow panel.

Related Pages