Webhook Messages
Order Created Webhook
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
post/api/v1/webhooks/order-created
Request
- The document declares no server URL.
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.