Webhook Trigger
Courier’s business tier customers have access to Webhook Triggers in Automations. Webhook Triggers enable you to connect other products and systems to Courier and trigger Automations based on events that happen in those systems. You have the full context of the webhook event payload and can use this data within the automation to send notifications, update profiles, or run workflows using Automation steps. This guide will walk you through how to register an inbound webhook and set up a Webhook Trigger.
BETA
This feature is currently in Beta, please reach out to Courier Support to have it enabled for your account.
Register an Inbound Webhook
- Go to Settings > Inbound Webhooks and click the “Add Inbound Webhook” button.
- You will be prompted to enter a name and description for the webhook.
After you save the webhook, you will be presented with a unique URL that you can use to send events to Courier. When you set up the webhook trigger in Automations, you will see a list of all of your registered inbound webhooks by the name. The events are tied to the name you select, and you cannot change the name after you save the webhook.
Configure the Webhook
Use the webhook URL that was generated in the previous step to configure the webhook in your system. Exercise a normal workflow to trigger various events to Courier, which will enable them as configuration options in the Automation trigger.
Inbound Webhook Payload
Courier accepts any payload up to 6Mb in size.
If the payload is a JSON object, Courier will parse the payload and make the data available to you in the Automation. If the payload is not a JSON object, Courier will make the entire payload available to you in the Automation as a raw string.
If the JSON object is an array, Courier will parse each object in the array and trigger an automation for each incoming event.
For JSON objects, Courier will extract the following fields if they are present.
event- The name of the event that triggered the webhook. You can filter by the name when you set up the webhook trigger in Automations. If no string field named event is present, Courier will use “Custom” as the default name.userId- A user identifier attached to the event. Courier will use this value to identify the user in the Automation, and automatically load associated profile data into the automation context.properties.courier.automation- A JSON object containing one of the following fields:template- The id of an existing automation template to invoke, instead of using a configured webhook trigger.steps- A JSON object containing the steps for an ad-hoc automation to execute.
If you have an event name or user Id keyed by a different field name in the webhook payload, please reach out to Courier Support to have that field mapped.
Using the Webhook trigger in an Automation
- Go to Automations and create a new automation
- Drag and drop “Webhook” from the list of triggers.
- In the Source field, select your registered inbound webhook name.
- After you select the webhook, you can select the event name from a list of any received events, or Custom if your payload did not contain named events.
The data payload in the webhook will be available to you in the Automation in the normal data object, accessed with refs.data.
If you don’t see any options in the Event field, make sure you have sent at least one event to the webhook from the source system.