Webhook events catalog

Two fields describe a delivery:

type identifies the payload family returned in data
triggeringEvent identifies the public business event that caused the webhook

triggerName is related but distinct: it identifies the configured trigger scenario that matched and caused the delivery. Multiple configured triggers may produce deliveries for the same triggeringEvent.

Public events catalog

The following public events are currently supported for webhook deliveries.

Order events

Event	Meaning
`order.confirmed.v1`	Published when an order is confirmed.
`order.withdrawal_submitted.v1`	Published when a withdrawal of one or more order items is submitted by the customer.

Parcel events

Event	Meaning
`parcel.prepared_by_merchant.v1`	Published when parcel progress changes to Prepared by Merchant.
`parcel.submitted_to_carrier.v1`	Published when parcel progress changes to Submitted to Carrier.
`parcel.delivered_to_pickup_point.v1`	Published when parcel progress changes to Delivered to Pickup Point.
`parcel.delivered_to_consumer.v1`	Published when parcel progress changes to Delivered to Consumer.
`parcel.terminated.v1`	Published when parcel progress changes to Terminated because delivery can no longer be completed.
`parcel.sent_back.v1`	Published when parcel progress changes to Sent Back and the parcel is returning to the sender.
`parcel.on_route.v1`	Published when parcel progress changes to On Route.
`parcel.out_for_delivery.v1`	Published when the carrier marks the parcel as out for final-mile delivery.
`parcel.delivery_attempt_failed.v1`	Published when a delivery attempt fails.
`parcel.delivery_delayed.v1`	Published when the carrier reports that delivery is delayed.
`parcel.estimated_delivery_time_updated.v1`	Published when the parcel ETA is updated.
`parcel.estimated_delivery_time_exceeded.v1`	Published when the current parcel ETA is exceeded.

Payload families

`ECOM_ORDER`

idstringrequired

Unique delivery identifier. Use this for idempotency and deduplication.

createdAtstring, (date-time)required

Timestamp when the webhook delivery was created.

triggerNamestringrequired

Name of the configured trigger that generated the delivery.

triggeringEventany(Webhooks.OrderPublicEventType)required

One of:

Published when an order is confirmed.

string(order.confirmed.v1)

typestringrequired

Payload model type for the data object.

Value:"ECOM_ORDER"

dataobject(Webhooks.EcomOrder)required

Complete e-commerce order model with fulfillments and parcels

`PARCEL`

idstringrequired

Unique delivery identifier. Use this for idempotency and deduplication.

createdAtstring, (date-time)required

Timestamp when the webhook delivery was created.

triggerNamestringrequired

Name of the configured trigger that generated the delivery.

triggeringEventany(Webhooks.ParcelPublicEventType)required

One of:

Published when parcel progress changes to Prepared by Merchant.

string(parcel.prepared_by_merchant.v1)

typestringrequired

Payload model type for the data object.

Value:"PARCEL"

dataobject(Webhooks.Parcel)required

Parcel model with associated order data

Event payload models

The data field uses these schemas:

EcomOrder for order-level deliveries
Parcel for parcel-level deliveries