> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api-docs.zippd.com/llms.txt.
> For full documentation content, see https://api-docs.zippd.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api-docs.zippd.com/_mcp/server.

# 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:

```json
{
    "url": "https://yourcompany.com/webhooks/zippd"
}
```

See the [webhook API resource reference](/following-your-delivery/receive-updates-via-webhooks) 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:

```json
{
    "event_name": "order_status_updated",
    "data": {
        "id": "ff92a2ed-7c19-4e07-ba35-d4a067c35f67",
        "code": "DA6X6A0M",
        "last_status": "accepted",
        "start_at": null,
        "completed_at": null
    }
  }
```

#### List of Statuses: Non-Dedicated Deliveries

| **Status**           | **Description**                                                                   |
| -------------------- | --------------------------------------------------------------------------------- |
| `out-for-delivery`   | The driver has the items and has started drop-offs                                |
| `unsuccessful`       | There was a logistical issue, or a problem with receiving or processing the goods |
| `delivered`          | The goods have been successfully delivered                                        |
| `delivery-attempted` | The driver attempted to deliver the goods but the recipient was not available     |