Overview

To receive updates from API it's beneficial to have mechanisms like Webhooks. Pio API supports these webhooks in RESTful manner so developers don't have to configure and maintain webhooks manually. You can create, update, list and delete these hooks with usual HTTP methods. Pio API has well defined events that trigger these hooks.

warning

For a message to be considered successfully delivered it is expected that the integration responds with a 2XX status code within 5 seconds

Integrations can create hook for each supported event for each shop, for hook to go through one needs to make sure that target_url for a particular event accept payload and returns 200. We will look at list of all supported events and corresponding payloads in next section.

If Pio does not receive a 2XX when sending a message, it will retry for up to 24 hours before giving up. Retried requests will have the same X-Pio-Delivery-Id header to provide idempotency.