Webhooks
Create a webhook endpoint
The URL must be https, on port 443 or 8443, and resolve to a public address. The response carries the signing secret — the only time it is shown. Store it; rotate it if it leaks.
Created with an OAuth access token, the endpoint belongs to that connection: only the app sees it, and it is deleted when the merchant disconnects the app or approves it again. Register your endpoints right after each approval.
Body
- urlstringRequired
up to 2048 characters
- eventsarray of WebhookEventTypesRequired
The event types to send, or
["*"]for all of them (including ones added later).One of
*,order.created,order.updated,order.status_changed,order.cancelled,order.needs_review,order.note_added,product.created,product.updated,product.deleted,inventory.updated,customer.created,customer.updated,shipment.created,shipment.updated,abandoned_checkout.created,abandoned_checkout.updated,review.created,bulk_job.completed
up to 64 items · at least 1 item - descriptionstring
up to 200 characters
Returns
201 Created · The endpoint, with its signing secret. WebhookEndpoint
- idstring
starts with we_
- objectstring
always "webhook_endpoint"
- urlstring
uri
- descriptionstring or null
- eventsarray of strings
- statusstring
auto_disabled: every delivery failed for 3 days, so Ordexs stopped sending. Setstatus: enabledto resume.One of
enabled,disabled,auto_disabled - disabled_reasonstring or null
- failing_sincestring or null
When deliveries started failing without a success since.
ISO 8601 date-time, UTC
- livemodeboolean
- secretstring
Only in the response to create and rotate_secret.
- created_atstring
ISO 8601 date-time, UTC
- updated_atstring
ISO 8601 date-time, UTC
Errors
Every error has the same shape. This endpoint can answer with:
