References¶

Receiving incidents¶

To receive new incidents via our webhook, you need to implement the following endpoint:

POST /v2/incidents

Payload Fields¶

Parameter	Type	Description
bookingReference	String	The booking reference.
incidentType	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`	The type of incident reported by the customer.
incidentStatus	One of the following values: `RESOLVED` `DISPUTED`	The current status of the incident. The status can have two values: `RESOLVED` - Incident is marked as resolved on Booking.com systems `DISPUTED` - Incident has been created and is being investigated by Booking.com.
responsibleParty	One of the following values: `CUSTOMER` `NO_ONE` `BOOKING.COM` `SUPPLIER`	The responsible party for the incident.
createdDateTimeUTC	DateTime	Incident created date time in UTC (ISO 8601).
pickupDateTimeUTC	DateTime	Incident pickup date time 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 incidents update¶

To receive updates to existing incidents via our webhook, you need to implement the following endpoint:

PATCH /v2/incidents

Payload Fields¶

Parameter	Type	Description
bookingReference	String	The booking reference.
incidentType	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`	The type of incident reported by the customer.
incidentStatus	One of the following values: `RESOLVED` `DISPUTED`	The current status of the incident. The status can have two values: `RESOLVED` - Incident is marked as resolved on Booking.com systems `DISPUTED` - Incident has been created and is being investigated by Booking.com.
responsibleParty	One of the following values: `CUSTOMER` `NO_ONE` `BOOKING.COM` `SUPPLIER`	The responsible party for the incident.
modifiedDateTimeUTC	DateTime	The time the incident was modified date time in UTC (ISO 8601).

Sample Payload¶

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

References¶

Receiving incidents¶

Payload Fields¶

Sample Payload¶

Responses¶

HTTP 204 - No content¶

HTTP 4xx - Client error - Error response format¶

HTTP 5xx - Server error - Error response format¶

Receiving incidents update¶

Payload Fields¶

Sample Payload¶

Responses¶

HTTP 204 - No Content¶

HTTP 4xx - Client error - Error response format¶

HTTP 5xx - Server error - Error response format¶

HTTP 4xx - Client error - Error response format ¶

HTTP 5xx - Server error - Error response format ¶

HTTP 4xx - Client error - Error response format ¶

HTTP 5xx - Server error - Error response format ¶