Listening for Rider Events

Once you have configured the Rider Events webhook, Deliveroo will begin notifying your integration about rider-related events

The Rider Events webhook is meant to be informational. How you process the information provided through this webhook depends on your requirements.

A typical rider status lifecycle is EN_ROUTE_TO_SITE → ARRIVED_AT_SITE → CONFIRMED_AT_SITE -> EN_ROUTE_TO_CUSTOMER -> ARRIVED_AT_CUSTOMER -> CONFIRMED_AT_CUSTOMER -> COMPLETED_DELIVERY.

Please note that several riders can be assigned to a delivery if it's too big for one to fulfill. You can expect to see repeated statuses in those cases.

Event payload

{
  "event": "riders.update_status",
  "body": {
    "delivery_id": "f7e458ec-3d8e-4271-9a25-34d2fa125782",
    "external_ref_id": "6823e970-283d-4bfd-849e-7bcb0e4a1b40#courier",
    "riders": [
		{
			"rider_id": "4d50561f-2950-44e3-af7a-f7c60a6a014e"
			"status": {
			    "effective_at": "2024-01-01T08:00:00.52Z",
			    "status": "EN_ROUTE_TO_SITE"
			}
		},
		{
			"rider_id": "47cd3007-4723-4b25-ae76-b7e614078aa5"
			"status": {
			    "effective_at": "2024-01-01T08:05:00.52Z",
			    "status": "CONFIRMED_AT_SITE"
			}
		}
	]
  }
}

Rider Statuses

Rider StatusDescription
EN_ROUTE_TO_SITEThe rider has accepted the delivery and is en route to the site.
ARRIVED_AT_SITEThe rider is nearing the site.
CONFIRMED_AT_SITEThe rider has reached the site, confirmed on the Rider App.
EN_ROUTE_TO_CUSTOMERThe rider is en route to the customer location.
ARRIVED_AT_CUSTOMERThe rider is nearing the customer location.
CONFIRMED_AT_CUSTOMERThe rider has reached the customer, confirmed on the Rider App.
COMPLETED_DELIVERYThe rider has completed the delivery.

How do Rider Events Work?

Deliveroo sends you a notification via Rider Events webhook (rider.status_update) every time an event related to the
rider for a given delivery occurs:

  1. When a rider has accepted the delivery and is on their way to the site, you will receive a EN_ROUTE_TO_SITE event.
  2. You will receive a ARRIVED_AT_SITE event when a rider is close to a site.
  3. You will receive a CONFIRMED_AT_SITE when the rider confirms to be at the site on the Rider App.
  4. When a rider has picked up the cargo from the site and is on their way to the customer, you will receive a EN_ROUTE_TO_CUSTOMER event.
  5. You will receive a ARRIVED_AT_CUSTOMER event when a rider is close to the customer's location.
  6. You will receive a CONFIRMED_AT_CUSTOMER event when a rider has arrived to the customer's location.
  7. You will receive a COMPLETED_DELIVERY event when a rider has successfully delivered the cargo to the customer.

Failures

Retry Logic

Deliveroo will retry the request for up to 10 minutes.