Courier Update

Purpose

This webhook delivers real-time updates on each delivery job, based on information provided by the integrated Dispatch partner.

Requires Integrated Dispatch
A Dispatch provider needs to be integrated with a customer location for courier status updates to be received.

Format

Webhook events are triggered based on the following conditions. The same status enum may be sent multiple times, where other details e.g. geo-location are changing:

Courier co-ordinates change

pickupTimeETA or deliveryTimeETA changes by more than 60 seconds

Delivery status changes (e.g., DELIVERY_CREATED → EN_ROUTE_TO_PICKUP)

A courier is reassigned

Courier Statuses

For a full list of all courier status values, see the link below;

Tracking URL Availability
A tracking URL is returned only when supported by the Dispatch provider.

Payload
string

The unique ID of the order in Deliverect.

string

The unique ID of the order sourced from the ordering channel.

integer

The status from the list of values supported for updates.

date-time

The arrival time for the courier to their pickup location, in UTC yyyy-MM-ddTHH:mm:ss.SSSZ (only available prior to status ARRIVED_AT_PICKUP - 85).

date-time

The delivery time, in UTC yyyy-MM-ddTHH:mm:ss.SSSZ.

string

Name of the courier / rider.

coordinates
object

The coordinates object showing "coordinates": { "coordinates": [long, lat] }.

string

Where the Deliverect Courier App is used, this is the unique ID of the courier.

string

The name of the dispatch partner company.

boolean

Sent as true when the delivery is split across more than one driver.

string

Tracking URL for the delivery job. Only returned when supported by the Dispatch provider.

Headers
string
required
Defaults to Deliverect/{version}

Identifies Deliverect as the sender of the webhook, in the format Deliverect/{version}.

string
required
Defaults to {signature}

HMAC-SHA256 signature of the raw request body, generated with your shared secret. Recompute the signature on receipt and compare it to this value to verify the request came from Deliverect (see the HMAC authentication guide).

Responses

LoadingLoading…