Receive Updates via Webhooks

The Zippd platform can send updates as they happen to your systems via webhooks. This works well for an ongoing service such as delivery, and is an efficient way to keep your system closely synchronised with the live state of your orders and account.

Set Your Webhook URL

Use the Webhook endpoint of the API to manage webhooks in your account. All you need to send is the absolute URL to which you want us to send updates:

1
{
2
    "url": "https://yourcompany.com/webhooks/zippd"
3
}

See the webhook API resource reference for more details on making these requests. All URLs that are set will receive updates from our server until they are removed. You cannot activate or deactivate webhook URLs.

Webhook Events

All webhook requests are sent with the POST method and will contain data from the affected resource.

order_status_updated

The order_status_updated event is sent any time the status of an order is updated. The possible statuses differ based on the type of order.

Here’s an example payload:

1
{
2
    "event_name": "order_status_updated",
3
    "data": {
4
        "id": "ff92a2ed-7c19-4e07-ba35-d4a067c35f67",
5
        "code": "DA6X6A0M",
6
        "last_status": "accepted",
7
        "start_at": null,
8
        "completed_at": null
9
    }
10
  }

List of Statuses: Non-Dedicated Deliveries