Skip to content

Understanding our event endpoints

What does it do?

The driver event endpoints allow you to send real-time driver status updates during a booking's lifecycle. These updates are shown to customers to reduce anxiety at pickup time.

Warning

Before you can send driver events you must first assign a driver. The booking must be in DRIVER_ASSIGNED state.

Event sequence

Events must be sent in chronological order. The expected sequence is:

DRIVER_DEPARTED_TO_PICKUP
    → DRIVER_ARRIVED_AT_PICKUP
        → DRIVER_DEPARTED_TO_DROPOFF  (customer collected)
            → DRIVER_ARRIVED_AT_DROPOFF  (journey complete)

Alternative path (no-show): 

DRIVER_DEPARTED_TO_PICKUP
    → DRIVER_ARRIVED_AT_PICKUP
        → DRIVER_SUBMITTED_CUSTOMER_NO_SHOW

Additionally, DRIVER_LIVE_LOCATION can be sent repeatedly (every 5 seconds) throughout the journey for real-time GPS tracking.

How does it work?

  1. Authenticate — obtain an access token
  2. Assign a driver — booking transitions to DRIVER_ASSIGNED
  3. Send events — call POST /v1/bookings/:customerReference/:bookingReference/driver/events with each event as it occurs
  4. Send live location (optional) — send DRIVER_LIVE_LOCATION every 5 seconds with GPS coordinates

See our endpoint references for full request/response details.

Further reading