Status Update Webhook

The payload schema for our status update webhook can be found below

Gophr is able to notify you when a delivery transitions from one status to another by sending a webhook to a URL of your choice. Webhooks are sent when a job changes to any of the following statuses:

ACCEPTED_BY_COURIER
AT_PICKUP
EN_ROUTE
AT_DELIVERY
TAKING_SIGNATURE
DELIVERED
CANCELED_BY_CUSTOMER

Status update webhooks contain the following data:

Delivery ETA's
Courier details
Courier location (latitude and longitude)
New delivery status
Price of the job (useful if the job is a return leg)
Delivery pickup / dropoff proof
Any details relating to a linked delivery

Linked Deliveries

Linked deliveries are deliveries that are automatically generated by Gophr. If an existing delivery has a linked delivery associated with it, we will include this using the linked_delivery field in the webhook payload.

Example payload Schema: Status

STATUS: 
{
  "delivery_id": "0dd41eb9-564d-4b5d-8acc-05b4cd8e0ae2",
  "external_id": "gophr-64a53d967f54d",
  "pickup_eta": "2023-07-03T10:57:16+01:00",
  "delivery_eta": "2023-07-03T11:09:28+01:00",
  "courier_location_lat": "51.50700000",
  "courier_location_lng": "-0.10500000",
  "status": "AT_DELIVERY",
  "leg_type": null,
  "price_net": {
    "amount": 11.91,
    "currency": "GBP"
  },
  "price_gross": {
    "amount": 14.29,
    "currency": "GBP"
  },
  "meta_data": [],
  "courier_name": "dCourier",
  "courier_notes": null,
  "courier_mobile_number": "+447777777777",
  "cancellation_comment": null,
  "proof_of pickup": [],
  "proof_of_delivery": [],
  "events": [
    {
      "timestamp": 1688547206,
      "status": "CONFIRMED_BY_CUSTOMER"
    },
    {
      "timestamp": 1688547419,
      "status": "ACCEPTED_BY_COURIER"
    },
    {
      "timestamp": 1688547436,
      "status": "AT_PICKUP"
    },
    {
      "timestamp": 1688547447,
      "status": "EN_ROUTE"
    },
    {
      "timestamp": 1688548168,
      "status": "AT_DELIVERY"
    }
  ],
  "linked_delivery": null
}