Following your Delivery

Receive Updates via Webhooks

View as Markdown

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 a limited amount of data from the affected resource. It is expected that you will inspect the data and make decisions on whether your systems need to retrieve more data to take action.

Events

Webhook requests will include an events item. The value of this will be one of the following:

  • updated
  • deleted

Data

Here’s an example payload:

1{
2    "event": "updated",
3    "event_resource_type": "Order",
4    "event_date_time": "2026-03-24T18:57:03+00:00",
5    "resource_id": "37b95d81-17ca-4f56-9fdc-8fe64a57adbc",
6    "resource_url": "https://api.deliveryapp.com/v1/orders/37b95d81-17ca-4f56-9fdc-8fe64a57adbc",
7    "data": {
8        "code": "DA6X6A0M",
9        "status": "in-progress"
10    }
11  }

The event_date_time item will always be UTC.

Resource Types

A list of order types and their supported events:

  • Order
    • updated
  • OrderLocation
    • updated
    • deleted

Webhook Responses

Status Code

Our servers expect an HTTP 200 response from any webhook requests that are sent. Any other status code will be interpreted as an error.

Timeout

Any request that does not receive a response within 5 seconds will be interpreted as an error.

Retries

Any webhook request that is interpreted as an error will be retried 2 more times.

  • After the first webhook request failure, our servers will wait 60 seconds before making a 2nd attempt
  • After the 2nd request failure, our servers will wait 5 minutes before making a 3rd attempt
  • There will be no attempts made after a 3rd failure