Skip to main content

WebHooks

Endpoints related to managing webhooks for near-realtime notification of changes. To be able to receive events you should subscribe the sepcific events by registering your webhook(s) using the methods outlined in this section. Once registered the system will invoke your endpoint whenever an event of the registered type occurs.

warning

The webhook services do not guarantee the arrival order of webhook events because network latency or temporary system downtime can scatter delivery. To handle event ordering reliably in your application, you must use the internal timestamps provided in the event payloads rather than relying on the sequence in which your API endpoint receives the HTTP requests.

Overview​

The WebHooks feature in Paxon ShopApi v3 allows your system to receive asynchronous notifications about important events in the fulfillment process. You can manage WebHooks via the following endpoints:

  • GET /v3/webhooks – List all WebHooks
  • POST /v3/webhooks – Create a new WebHook
  • GET /v3/webhooks/:id – Retrieve a specific WebHook by ID
  • PUT /v3/webhooks/:id – Update an existing WebHook
  • DELETE /v3/webhooks/:id – Remove a WebHook