Skip to main content

Subscribe to order events

POST /v1/webhook_subscriptions

Each event is POSTed to url as JSON, signed with the subscription's secret.

Authentication​

Send a token issued in the Zoopit dashboard as Authorization: Bearer <token>.

Request body​

FieldTypeRequired
ownerstringyes
namestringyes
urlstringyes
eventsarray of WebhookEventyes
enabledboolean
tagsarray of string

Responses​

201​

resource: CreatedSubscriptionAsJson

FieldTypeRequired
namestringyes
urlstringyes
secretstringyes
eventsarray of WebhookEventyes
enabledbooleanyes
idstringyes
created_atstringyes
modified_atnull or stringyes
deleted_atnull or stringyes
created_bystringyes
modified_bynull or stringyes
deleted_bynull or stringyes
ownersarray of stringyes
tagsarray of stringyes
attributesobjectyes

Example​

curl -X POST 'https://orders-api.cloud.zoopit.no/v1/webhook_subscriptions'
-H 'Authorization: Bearer <token>'
-H 'Content-Type: application/json'
-d '{ ... }'

Try it in the interactive Orders API reference.

Field descriptions, guides and worked examples are in the full reference, available to customers in the Zoopit dashboard under Accounts → Developer.