Skip to content

Triggers

The Triggers page is used to manage Workflow Triggers in the system. Triggers are used to start workflows upon receiving an adapter event or a webhook (http request) event.

A Trigger may contain various conditions that are defined to filter the event from triggering the mapped workflow. Triggers build and supply the collection of properties that are passed to the workflow, based on the event or webhook properties.

The Triggers overview page displays the list of currently configured triggers.

Property Description
Name The name of the trigger.
Type The type of trigger - can be Event or Webhook.
Item For Event triggers, this will be the adapter name and event name. For webhook triggers, this will be the webhook URI.
Workflow The workflow that will be executed by this trigger - i.e. the mapped workflow.
Condition The expression that, if evaluated to true, leads to start of workflow.
Enabled The state of the trigger (enabled/disabled).

Add/Edit Trigger

Triggers can be added and modified using the Triggers page.

  • To add a trigger, click Add Trigger.
  • To edit a trigger, select the Edit link associated with the desired trigger.
  • Triggers can also be cloned. To clone an existing trigger, select the Clone link. The user will be taken to the Add Trigger page, when clicking on the Clone link, with all trigger settings filled in to match except for the Name. The Name field will be blank and needs to be filled in with a unique name.
  • Each trigger must have a unique Trigger name.
  • Triggers must have a Type selected from one of the available Trigger Types:
    • Event
    • Webhook
  • An Event trigger needs the following configuration settings:
    • The adapter that sends the event notification
    • The name of the event that the adapter sends
    • The workflow to start when this trigger matches
  • A Webhook trigger needs the following configuration settings:
    • The Webhook URI
      • This is the URI that external systems will use to execute this trigger.
      • To copy the complete Webhook URI to the clipboard, press the Copy button.
    • The workflow to start when this trigger matches
  • A newly added trigger is disabled by default. It must be explicitly enabled for use.

Both trigger types can have a condition. This field is optional and the condition entered here is used to test if the trigger should start the workflow. The expression must have a valid syntax. If no condition is entered, the workflow will always be executed. See Condition Expressions for details. String Interpolation and JSON Flatten/Unflatten can also be used in the condition. For example the condition Regex(tempF, '\[0-9\]+') > 79 will be true only if the tempF property has a value larger than +79.

Users can also add any number of properties to pass from trigger to the workflow when it is started by the trigger. The properties are added in the form of name and value pairs (name is required but value is optional). String Interpolation and JSON Flatten/Unflatten are available for properties. For use of arrays in trigger properties see the Objects and Arrays section in String Interpolation and JSON Flatten/Unflatten. Only the properties listed explicitly in the trigger will be passed on to the workflow. If the workflow defines properties with the same name in the Workflow Properties collection, they will be overwritten by the properties map built by the trigger. An autocomplete list shows all the event properties of the selected adapter, built-in wfsystem workflow property and the functions.

Fields with non-blocking validation issues which still require your attention have a yellow warning message under them. For example, when an adapter which doesn't exist is used, etc.

After filling in the desired configuration settings, press Save to save the trigger. A confirmation message will be shown when this action is successful and an error message is shown when it fails. Note that in order to save an enabled trigger, the system will first need to confirm that there are sufficient trigger licenses.

The workflow engine will execute all triggers that match a specific event. IN other words, one incoming event can start multiple workflows (matching the trigger).

Delete Triggers

Triggers can be removed by using the Delete link on the Triggers page. An enabled trigger cannot be deleted, you need to first disable it.

Invoke Webhook triggers

See Webhook for more information.

Trigger and Workflow properties

Trigger and Workflow Properties