DOCUMENTATION

Journey Endpoints

REST API Journey Endpoints

Trigger Webhook Journey

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.

The Journey can then 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 customer's email address
session_data No JSON Object Metadata to be attached to the customer's 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.

Trigger Waiting Journey Node

Journeys allows for a Node to set delivery rules, including the Wait for Event option, which allows you to configure the node to wait up to a specified number of days for an Inbound Webhook event.

When a Journey Node is configured for to wait for an Inbound Webhook, an explicit Webhook Endpoint URL will be provided. The Journey Node can then 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 customer's email address
session_data No JSON Object Metadata to be attached to the customer's current journey session metadata

The customer must actively be queued on the specific waiting journey node at the time this request is sent.

When cloning a journey, each node that has been configured to wait for a webhook will receive a new explicit Webhook Endpoint URL.

Back to Top