Webhooks payload structure

A webhook payload structure refers to the specific format in which data is transmitted when a webhook is triggered. Each entity has consistent keys across its different topics, which ensures uniformity and predictability in the payload structure.

The webhook payload is structured around four main entities:

Subscription

This entity tracks subscription-related events.

List of subscription webhook topics here.
Subscription entity webhook payload structure here.

Order

This entity is tracks order-related events such as order placed.

List of order webhook topics here.
Order entity webhook payload structure here.

PaymentMethod

This entity tracks paymentMethods related events such as paymentMethod update, expiring soon events, etc.

List of paymentMethod topics here.
paymentMethod entity webhook payload structure here.

Flows

This entity represents the different steps or processes involved in a customer journey or interaction.

List of flows topics here.