Order Delegation Webhook

Order Created Webhook

post

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

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

The webhook payload includes:

  • id: ID of the webhook message

  • event: The event type (order.created)

  • 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

Authorizations
X-API-KeystringRequired
Body
idany ofOptional
integerOptional
or
nullOptional
eventconst: order.createdRequired

Event type of webhook message

timestampstring · date-timeOptional
subscription_idany ofOptional

ID of the subscription

integer · min: 1Optional

ID (integer) of this property

Example: 1
or
nullOptional
Responses
post
/api/v1/webhooks/order-created
200

OK

No content

Last updated

Was this helpful?