When configuring a new journey, one of the Trigger options is Webhook. A webhook-triggered journey will provide an explicit Webhook Endpoint URL to be used for triggering the journey.
When cloning a journey, a new explicit Webhook Endpoint URL will be generated.
Journeys can be triggered by sending a POST request to the provided Webhook Endpoint URL with the following payload structure:
Param Name | Required | Type | Description |
---|---|---|---|
email | Yes | String | The email address of the customer |
session_data | No | JSON Object | Metadata to be attached to the customer's journey session metadata |
The customer must already exist in your site account, which means there must have been a previous interaction, such as a previously identified cart or browse session, being added to a list, etc.
If you want to ensure that every customer used to trigger a webhook journey already exists, you can use the Create Customer Profile endpoint prior to triggering the journey.