Webhooks

job_delivery_status_updated

This event is triggered when a job's status changes, e.g. when it is accepted by the driver, picked up, completed, etc.

Specific Data for this message

JSON Field	Type	Description
job_uuid	string	Job UUID
job_delivery_status	string	The new status, as documented below.
job_delivery_status_agent_uuid	string	The driver's UUID
job_delivery_status_agent_location	object containing latitude, longitude, and recorded_at	The driver's most recent location
order_description	string	Your internal friendly order ID
account_uuid	string	Store UUID
published_at	integer, unix timestamp	The time the event occurred
order_account_business_partners_external_identifier	string	The business's unique ID on your system. This can be set when setting up a business.
order_account_partners_external_identifier	string	The store's unique ID on your system. This can be set when setting up a store.
order_uuid	string	Order UUID
partners_unique_internal_order_id	string	The order's unique ID on your system. This can be set when creating orders.
order_custom_fields	hash or null	If you passed through a hash of custom fields to the order creation API (custom_fields), this will then be passed back to you here.

Possible Statuses

Name	Description
unassigned_to_driver	The order has been unassigned from the driver.
assigned_to_driver	The order has been assigned.
assigned_and_accepted_by_driver	The order has been accepted by the driver.
collected	The order has been collected / picked up.
dropped_off	The order has been dropped off (and thus completed).
returning_to_pickup_with_delivery	The order is being returned to the pickup location with the delivery. This means that the driver marked it as a failed delivery.
auto_closed	The order has been auto closed by our system. By default this feature is turned off and whether it is feasible to turn on depends on the integration. Please speak to your account manager.

Example Webhook Payload

{
  "data": {
    "job_uuid": "a41d767aac70",
    "job_delivery_status": "assigned_to_driver",
    "job_delivery_status_agent_uuid": "2933a9574fa0",
    "job_delivery_status_agent_location": {
      "latitude": "13.715925",
      "longitude": "100.585788",
      "recorded_at": "2025-03-13T08:14:47.267+00:00"
    },
    "order_description": "1506-177",
    "account_uuid": "a9c7b6a24e67",
    "published_at": 1741853746.4946675,
    "order_account_business_partners_external_identifier": "",
    "order_account_partners_external_identifier": "",
    "order_uuid": "a41d767aac70",
    "partners_unique_internal_order_id": "cf22a4c0-0e6a-41cc-a0fe-96a76f5085e4",
    "order_custom_fields": null
  },
  "event_name": "job_delivery_status_updated",
  "environment": "production",
  "created_at": "2025-03-13T08:15:46.503+00:00",
  "event_uuid": "ae9b6746-48ca-40db-9058-f74ab6b25c05",
  "metadata": {
    "sent_at": "2025-03-13T08:15:46.513+00:00",
    "delivery_attempt": 1
  }
}