WebHooks
Apps can use webhooks to execute code after a certain event happens on the platform, for example after a new order or when customer data is modified.
Instead of periodically pulling objects via the API, the app can register webhooks which send an http(s) request to the app when the registered event occurs.This is easer to implement, uses less resources for API calls, allows for fast response after events and over all helps to create more robust apps.
Webhooks are scoped to the app and company they are bound to. A webkook does not receive events for other companies and other apps don’t influence triggering registered events.
API | Description |
---|---|
GET api/webhooks/count.json |
No documentation available. |
GET api/webhooks.json |
No documentation available. |
POST api/webhooks.json |
No documentation available. |
PUT api/webhooks.json |
No documentation available. |
GET api/webhooks/{ids}.json |
No documentation available. |
POST api/webhooks/{ids}.json |
No documentation available. |
PUT api/webhooks/{ids}.json |
No documentation available. |
DELETE api/webhooks/{ids}.json |
No documentation available. |
POST api/WebHooks |
No documentation available. |