Event-Based Triggers

Creating a Workflow based on an Event from an External Service Provider

A Workflow with anEvent-based Trigger runs when it is triggered by a specified event on an external service provider.

1. When Creating a New Workflow, select the Event-based Workflow trigger type.

2. Optional- Configure the advanced settings and proceed by clicking the "Create Workflow" button. The Workflow Editor page will open.

3. Under the Trigger:Event-Based section, select the "Click to select and event" option.

4. Select an external service provider, select a supported event and then click the Continue button. The Trigger setup popup will appear.

5. In connections, select an existing connection or create a new connection.

6. Proceed by entering all required inputs. If you want to trigger the Workflow only under certain conditions, enable Add condition . See how to use the Condition Builder for more details.

7. Click Apply. When this event occurs and the conditions are met, the Workflow is triggered.

Interactive Guide: Creating an Event-Based Trigger.

You can also refer to the following tutorial guides for a more in-depth understanding of how to create an Event-Based Trigger.

Viewing the Event Payload of an Event-Based Workflow

See the Event Payload that triggered a certain event.

note

This is relevant for workflows triggered by webhooks and pre-defined events.

• View the event payload of an Event-Based Workflow by clicking Sample Event in the bottom-left corner of the Trigger setup. An Event dialog box opens. You can copy the event to create another Workflow.

Creating an Event-Based Workflow using a Custom Webhook

Event-based Workflow using a Custom Webhook runs when it is triggered by an event sent to predetermined URL by the webhook.

info

When using Webhooks in Event-Based Workflows, you can choose between two authentication methods: The API Key authentication method and Signature authentication method. The authentication method adds an extra layer of security. For more information about Webhooks, API Key authentication, and Signature authentication method, click here.

1. When Creating a New Workflow, select the Event-based Workflow trigger type.

2. Optional- Configure the advanced settings and proceed by clicking the "Create Workflow" button. The Workflow Editor page will open.

3. Under the Trigger:Event-Based section, select the "Click to select and event" option.

4. Select the Custom webhook option and then click the continue button. The Webhook setup will open.

5. Optional- You can further customize the webhook by assigning a different name to the Webhook Event.

6. Copy the Webhook URL and API KEY and store it in a safe location, you will require it later on in the process, for the external service provider.

info

The Webhook URL displayed ,is the URL you need to notify when your custom event occurs.

7. Choose an authentication method: The API Key authentication method or Signature authentication method.

8. The event received from the remote service provider is an unfamiliar JSON object to the system. Use one of the methods below to show the system what to expect:

   1. Click Configure event schema > Get started. In Sample event click Listen. Send a sample event to the Webhook URL defined in the settings and then click the Apply button.

   OR

   2. Click Configure event schema > Set manually. In Sample event , paste a sample event so the system knows what to expect then click the Apply button.

9. To trigger the Workflow only under certain conditions, enable Add condition . See how to use the Condition Builder for more details.

10. Click the Apply button.