v1

latestOpenAPI 3.1.02026-07-23307478.5 KB
Webhook Messages

Order Updated Webhook

This is a dummy endpoint that demonstrates the webhook payload structure that will be sent to webhook subscribers when an order.updated event occurs.

The order.updated event is triggered whenever an order's status changes. This is the recommended webhook for tracking order status changes.

The actual webhooks will be sent asynchronously to the URLs specified in the webhook subscriptions that are subscribed to the order.updated event type.

The webhook payload includes:

  • id: ID of the webhook message
  • event: The event type (order.updated)
  • timestamp: When the event occurred
  • subscription_id: ID of the webhook subscription
  • message: The order data in the same format as the GET /orders/{id} endpoint
post/api/v1/webhooks/order-updated

Request body

idinteger required

ID of the webhook message

event'order.updated' required

Event type of webhook message

timestampstring date-time

UTC timestamp when the event was created

subscription_idinteger nullable

ID (integer) of this property

Response

OK