Skip to content

References

Receiving incidents

To receive new incident notifications via the webhook, implement the following:

POST /v2/incidents

Payload Fields

Parameter Type Description
bookingReference String The booking reference.
incidentType String One of the following values:

DRIVER_LATENESS
DRIVER_NO_SHOW
CUSTOMER_NO_SHOW
SERVICE_PROVIDED
RIDEWAYS_SERVICE
WRONG_VEHICLE
DRIVER_SERVICE
SUPPLIER_SERVICE
DRIVER_DELAY_20_TO_40_MINS
DRIVER_DELAY_UNDER_20_MINS
DRIVER_DELAY_OVER_40_MINS
INVESTIGATING_POST_JOURNEY_FEEDBACK
OTHER
incidentStatus String The current status of the incident:

DISPUTED — incident created, being investigated by Booking.com
RESOLVED — incident marked as resolved
responsibleParty String The party responsible for the incident:

CUSTOMER
NO_ONE
BOOKING.COM
SUPPLIER
createdDateTimeUTC DateTime Incident creation timestamp in UTC (ISO 8601).
pickupDateTimeUTC DateTime The booking's pickup timestamp in UTC (ISO 8601).

Sample Payload

{
  "bookingReference": "123456789",
  "incidentType": "CUSTOMER_NO_SHOW",
  "incidentStatus": "RESOLVED",
  "responsibleParty": "CUSTOMER",
  "createdDateTimeUTC": "2024-08-05T13:18:50",
  "pickupDateTimeUTC": "2024-08-05T10:18:50"
}

Responses

HTTP 204 - No Content

HTTP 4xx - Client error — Error response format

HTTP 5xx - Server error — Error response format


Receiving incident updates

To receive updates to existing incidents, implement the following:

PATCH /v2/incidents

Note

The PATCH endpoint does not include a booking reference in the URL path. The incident is identified by the bookingReference field in the payload body.

Payload Fields

Parameter Type Description
bookingReference String The booking reference.
incidentType String One of the following values:

DRIVER_LATENESS
DRIVER_NO_SHOW
CUSTOMER_NO_SHOW
SERVICE_PROVIDED
RIDEWAYS_SERVICE
WRONG_VEHICLE
DRIVER_SERVICE
SUPPLIER_SERVICE
DRIVER_DELAY_20_TO_40_MINS
DRIVER_DELAY_UNDER_20_MINS
DRIVER_DELAY_OVER_40_MINS
INVESTIGATING_POST_JOURNEY_FEEDBACK
OTHER
incidentStatus String The current status of the incident:

DISPUTED — incident created, being investigated by Booking.com
RESOLVED — incident marked as resolved
responsibleParty String The party responsible for the incident:

CUSTOMER
NO_ONE
BOOKING.COM
SUPPLIER
modifiedDateTimeUTC DateTime The timestamp when the incident was last modified in UTC (ISO 8601).

Sample Payload

{
  "bookingReference": "123456789",
  "incidentType": "CUSTOMER_NO_SHOW",
  "incidentStatus": "RESOLVED",
  "responsibleParty": "CUSTOMER",
  "modifiedDateTimeUTC": "2024-08-05T13:18:50"
}

Responses

HTTP 204 - No Content

HTTP 4xx - Client error — Error response format

HTTP 5xx - Server error — Error response format


Further reading