Webhooks API 2.0
Important notice
This website does not contain documentation of the newest features.
If you are a new user of the Kiwi.com
APIs, we highly recommend using
tequila.kiwi.com.
To access Tequila documentation, create an account.
If you have any questions, use the Tequila support page.
Welcome to the latest Kiwi.com‘s PUSH API documentation, which details how relevant information about the state of a reservation is delivered to the customers’ endpoint. Below, we describe all notifications that are sent from Kiwi.com.
Should you need any further information or detail, please contact your Kiwi.com line manager.
Migrating to Webhook 2.0 from older versions
Older versions of webhooks don’t support the newest features. Guide on how to migrate can be found in Tequila.
PUSH notifications ¶
The following JSON will be delivered to the specified API endpoint (POST method), which has to respond with an HTTP 200 status. Otherwise, the call will be repeated every 5 minutes.
PLEASE NOTE:
- Do not strictly validate the request so there is no impact on implementation if new atribbute is added
- Do not validate
trigger
as enum so we can amend the list of “triggers” from our end
Example calls ¶
Single notification sending can be triggered as part of various processes - trigger attributes is code name for process that preceded triggering of notification sending.
The following are the statuses that can be assigned:
-
additional_service
-
additional_service_failed
-
online_checkin_not_available
-
travel_document_request
-
technical_issue
-
bp_sent
-
security_issue
-
security_issue_first_appeal
-
cancelled
-
sold_out
-
delayed
-
airport_checkin_document_missing
-
airport_check_in_with_boarding_document
-
refund
-
flight_change_pricing_ready
-
cancellation_declined
-
passenger_long_name
-
passengers_detail_changed
-
avc_emd_confirmation
-
received
-
guarantee_hotel_confirmed
-
name_corrected
-
security_verification_passed
-
proof_of_refund
-
proof_of_void
-
medical_certificate
-
baggage_airport_payment
-
price_changed
-
duplicity_booking
-
allocated_seating
-
schedule_change
-
confirmed
additional_passenger_information_required ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 123456789,
"type": "additional_passenger_information_required",
"mmb_link": "https://kiwi.com/en/content/manage/123456789/14810cad-1e14-469d-8784-cdf7023bc1fc",
"trigger": "additional_passenger_information_required",
"affected_segments": [
{
"src": "DPS",
"dst": "CGK",
"departureUtc": "2020-11-27T10:50:00+00:00"
}
]
}
Headers
Content-Type: application/JSON
Body
{}
additional_passenger_information_requiredPOST/
Applicable triggers:
additional_passenger_information_required
received ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "received",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "received"
}
Headers
Content-Type: application/JSON
Body
{}
confirmed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 141903465,
"type": "confirmed",
"mmb_link": "https://kiwi.com/en/manage/141903465/fabfc6bc-34b1-4eb0-b7e8-9af730eac00b",
"trigger": "confirmed",
"transactions": [
{
"amount_currency": {
"amount": "821.20",
"currency": "CZK"
},
"amount_eur": {
"amount": "32.33",
"currency": "EUR"
},
"type": "monetary",
"extra_id": 12345,
"created_at": "2020-01-28T16:22:37-07:00"
}
],
"transactions_total_eur": "30.31",
"itinerary": {
"segments": [
{
"return": true,
"carrier": {
"code": "HA",
"name": "Juneyao Airlines",
"public_code": "HA",
"segment_code": "1078"
},
"operating_carrier": {
"code": "HA",
"name": "Juneyao Airlines",
"public_code": "HA",
"segment_code": "1078"
},
"cabin_class": "first_class",
"arrival": {
"time": {
"local": "2021-02-13T07:55:00+07:00",
"utc": "2021-02-13T00:55:00+00:00"
}
},
"departure": {
"time": {
"local": "2021-02-13T07:55:00+07:00",
"utc": "2021-02-13T00:55:00+00:00"
}
},
"type": "flight",
"src": "BCN",
"dst": "PRG",
"iata": "VY",
"departure_time_utc": "2021-07-17T05:40:00+02:00",
"pnr": "AR2VS8",
"pnr_availability_from_utc": null,
"boarding_document_availability_from_utc": "2021-07-10T05:40:00+00:00",
"boarding_document_availability_to_utc": "2021-07-17T01:40:00+00:00",
"boarding_documents_link": null,
"passengers": {
"30582827": {
"name": "Toby",
"surname": "Fernandes",
"birthday": "1989-06-26",
"pnr": "AR2VS8",
"gds_ticket_number": "AR2VS8",
"boarding_document_link": null,
"mobile_boarding_document_link": null
}
},
"card_copy_links": [
null
]
}
],
"boarding_documents_link": null,
"mobile_boarding_documents_link": null,
"eticket_link": "https://mailing-files-dropzone.s3.eu-west-1.amazonaws.com/1617174321_E-ticket_passenger_1f4c3540dc60be682012764c30b4669d.pdf?v=1617174321",
"invoice_link": "https://skypicker-invoices.s3-eu-west-1.amazonaws.com/invoice_2021_a72375b3bf284726_171837204.pdf"
},
"baggage": {
"30582827": [
[
{
"category": "personal_item",
"height": 30,
"width": 20,
"length": 40,
"weight": 3,
"count": 1
},
{
"category": "cabin_bag",
"height": 40,
"width": 20,
"length": 55,
"weight": 10,
"count": 1
}
]
]
},
"credit_card_links": "https://mailing-files-dropzone.s3.eu-west-1.amazonaws.com/70116/card_70116112_868101cf20244fccb405af95caa40ebd_123456789000000_5095a87c68935fa57797ec7730139014.png"
}
Headers
Content-Type: application/JSON
Body
{}
confirmedPOST/
Applicable triggers:
-
confirmed
-
confirmed_booking_update
-
confirmed_not_fully_booked
-
confirmed_without_attachments
Baggage category parameter can be hold_bag
, personal_item
, or cabin_bag
.
delayed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 145314840,
"type": "delayed",
"mmb_link": "'https://kiwi.com/fr/manage/145314840/81634d44-5b2f-44a5-b197-e270ecb3ccab'",
"trigger": "booking_processing_delay",
"custom_data": {
"date": "2021-05-03 22:42:18",
"market": "fr",
"sub1": "3523815VPFR"
}
}
Headers
Content-Type: application/JSON
Body
{}
price_changed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "price_changed",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "price_changed",
"price_change": {
"occurred": "2019-08-08T14:43:10+02:00",
"currency": "USD",
"original_price": 1443,
"new_price": 3067,
"price_difference": 1414
}
}
Headers
Content-Type: application/JSON
Body
{}
flight_change_pricing_ready ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "flight_change_pricing_ready",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "flight_change_booked"
}
Headers
Content-Type: application/JSON
Body
{}
schedule_change ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "schedule_change",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "schedule_change_insignificant_auto_changed"
}
Headers
Content-Type: application/JSON
Body
{}
schedule_changePOST/
Schedule change gives you information about a change of one or more of the following attributes:
-
src
-
dst
-
departure_at
-
departure_local_at
-
arrival_at
-
arrival_local_at
-
fare_category
-
src_terminal
-
src_gate
-
dst_terminal
-
dst_gate
-
segment_code
-
carrier_code
-
carrier_segment_code
-
operating_carrier_code
-
operating_carrier_segment_code
-
type
Applicable triggers
Action required: Process the schedule change in Manage My Booking for the following triggers.
-
schedule_change_significant_guarantee_void
-
schedule_change_significant_info_pap_decides
-
schedule_change_significant_info_kiwi_decides
-
schedule_change_significant_confirmed_change
-
schedule_change_significant_info_reminder
No action required: Inform about the schedule change information in the webhook body for the following triggers.
-
schedule_change_insignificant_auto_changed
-
schedule_change_insignificant_info
-
schedule_change_insignificant_confirmed_change
-
schedule_change_insignificant_updated_change
-
schedule_change_generic
sold_out ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "sold_out",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "sold_out"
}
Headers
Content-Type: application/JSON
Body
{}
sold_outPOST/
Applicable triggers:
-
sold_out_alternative_payment_needed
-
sold_out_alternative_with_partial_refund
-
sold_out_alternative_within_budget
-
sold_out
technical_issue ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "technical_issue",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "technical_issue_alternative_within_budget"
}
Headers
Content-Type: application/JSON
Body
{}
technical_issuePOST/
Applicable triggers:
-
priority_technical_issue
-
technical_issue
-
technical_issue_pbpc
-
technical_issue_alternative_payment_needed
-
technical_issue_schedule_change
-
technical_issue_alternative_within_budget
bp_sent ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "bp_sent",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "bp_sent",
"itinerary": {
"segments": [
{
"type": "flight",
"src": "SEN",
"dst": "AMS",
"iata": "U2",
"departure_time_utc": "2017-09-11T06:10:00+02:00",
"pnr": "3412341234",
"pnr_availability_from_utc": null,
"boarding_document_availability_from_utc": "2017-08-12T06:10:00+00:00",
"boarding_document_availability_to_utc": "2017-09-11T04:10:00+00:00",
"boarding_documents_link": null,
"mobile_boarding_documents_link": null,
"passengers": {
"5544953": {
"name": "TEST",
"surname": "TEST",
"birthday": "1985-01-01",
"pnr": "3412341234",
"gds_ticket_number": "3412341234",
"boarding_document_link": null,
"mobile_boarding_document_link": null
}
},
"card_copy_links": []
}
],
"boarding_documents_link": null,
"mobile_boarding_documents_link": null,
"eticket_link": "https://mailing-files-dropzone-develop.s3.eu-west-1.amazonaws.com/3649/1565200313_E-ticket_passenger_0ae03c441149f3b00ca4e267243d9d40.pdf?v=1565200316"
},
"credit_card_links": "https://mailing-files-dropzone.s3.eu-west-1.amazonaws.com/70116/card_70116112_868101cf20244fccb405af95caa40ebd_123456789000000_5095a87c68935fa57797ec7730139014.png"
}
Headers
Content-Type: application/JSON
Body
{}
bp_sentPOST/
Applicable triggers:
-
bp_sent
-
bp_sent_without_attachments
-
boarding_documents_boarding_passes
-
boarding_documents_ground_tickets
-
boarding_documents_mixed_document
online_checkin_not_available ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "online_checkin_not_available",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "online_checkin_not_available",
"affected_segments": []
}
Headers
Content-Type: application/JSON
Body
{}
online_checkin_not_availablePOST/
Applicable triggers:
-
online_checkin_not_available
-
airline_online_checkin_technical_difficulty
-
checkin_failure
airport_checkin_document_missing ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "airport_checkin_document_missing",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "airport_checkin"
}
Headers
Content-Type: application/JSON
Body
{}
airport_checkin_document_missingPOST/
Applicable triggers:
-
airport_checkin
-
paid_checkin
-
free_checkin
-
checkin_by_passenger_required
airport_check_in_with_boarding_document ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 123456789,
"type": "airport_check_in_with_boarding_document",
"mmb_link": "https://kiwi.com/en/manage/123456789/000000-0000-0000-0000-000000000000",
"trigger": "airport_check_in_with_boarding_document",
"itinerary": {
"segments": [
{
"type": "flight",
"src": "BRQ",
"dst": "STN",
"iata": "FR",
"departure_time_utc": "2021-06-20T09:45:00+00:00",
"pnr": "TEST",
"pnr_availability_from_utc": null,
"boarding_document_availability_from_utc": "2021-06-19T09:45:00+00:00",
"boarding_document_availability_to_utc": "2021-06-20T07:45:00+00:00",
"boarding_documents_link": null,
"mobile_boarding_documents_link": null,
"card_copy_links": [],
"passengers": {
"31041496": {
"name": "TEST",
"surname": "TEST",
"birthday": "2002-01-01",
"pnr": "TEST",
"gds_ticket_number": "TEST",
"boarding_document_link": null,
"mobile_boarding_document_link": null,
"airport_check_in_document": "https://skypicker-documents.s3.amazonaws.com/BP/BP_156204488_CDG-WAW_SP32720148_38691318_32617042_1630933994.pdf"
}
}
}
],
"boarding_documents_link": null,
"mobile_boarding_documents_link": null,
"eticket_link": "https://mailing-files-dropzone-develop.s3.eu-west-1.amazonaws.com/1629985107_E-ticket_passenger_568e123121e46662a69376e5b8f3b991.pdf?v=1629985108",
"airport_check_in_documents": "https://skypicker-documents.s3.amazonaws.com/BP/BP_156204488_CDG-WAW_SP32720148_38691318_32617042_1630933994.pdf"
},
"credit_card_links": []
}
Headers
Content-Type: application/JSON
Body
{}
airport_check_in_with_boarding_documentPOST/
Applicable triggers:
- airport_check_in_with_boarding_document
travel_document_request ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "travel_document_request",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "expired_passport_request"
}
Headers
Content-Type: application/JSON
Body
{}
additional_service ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "additional_service",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "additional_extras",
"additional_extras": "There is food serving on flight"
}
Headers
Content-Type: application/JSON
Body
{}
additional_servicePOST/
Applicable triggers:
-
additional_services_system_confirmation_not_added
-
additional_services_system_confirmation_checkin
-
additional_services_system_payment_received
-
additional_services_system_confirmation_mix
-
additional_services_system_confirmation
-
additional_services_system_request
-
additional_services_system_status
-
additional_flights
-
additional_booking_credit_voucher_transfer
-
additional_booking_assisted_refund
-
additional_booking_assisted_no_refund
-
additional_luggage
-
additional_extras
-
assisted_refund_not_approved
-
assisted_refund_not_approved
-
assisted_refund_sent_final
additional_service_failed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "additional_service_failed",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "additional_service_processing_failure",
"unprocessed_services": [
"Pet",
"Too big baggage"
]
}
Headers
Content-Type: application/JSON
Body
{}
baggage_airport_payment ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "baggage_airport_payment",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "baggage_airport_payment",
"affected_segments": []
}
Headers
Content-Type: application/JSON
Body
{}
allocated_seating ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "allocated_seating",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "allocated_seating"
}
Headers
Content-Type: application/JSON
Body
{}
cancelled ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "cancelled",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "cancellation_confirmed"
}
Headers
Content-Type: application/JSON
Body
{}
cancellation_declined ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "cancellation_declined",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "cancellation_declined"
}
Headers
Content-Type: application/JSON
Body
{}
refund ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "refund",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "credits_allocated"
}
Headers
Content-Type: application/JSON
Body
{}
refundPOST/
Applicable triggers:
-
refund_calculator_cancellation_confirmation
-
refund
-
refund_application
-
refund_in_credits
-
refund_tax_after_departure
-
refund_approved
-
refund_processed
-
refund_application_without_airline_handling
-
refund_paypal
-
credits_allocated
proof_of_refund ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "proof_of_refund",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "proof_of_refund"
}
Headers
Content-Type: application/JSON
Body
{}
refund_not_approved ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "refund_not_approved",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "refund_not_approved"
}
Headers
Content-Type: application/JSON
Body
{}
proof_of_void ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "proof_of_void",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "proof_of_void"
}
Headers
Content-Type: application/JSON
Body
{}
security_issue ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "security_issue",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "security_issue"
}
Headers
Content-Type: application/JSON
Body
{}
security_issue_first_appeal ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "security_issue_first_appeal",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "security_issue_first_appeal"
}
Headers
Content-Type: application/JSON
Body
{}
security_issue_first_appealPOST/
Applicable triggers:
-
security_issue_first_appeal
-
jumio_higher_quality_proof_needed
-
jumio_verify
security_verification_passed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "security_verification_passed",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "security_verification_passed"
}
Headers
Content-Type: application/JSON
Body
{}
passenger_long_name ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "passenger_long_name",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "passenger_long_name"
}
Headers
Content-Type: application/JSON
Body
{}
avc_emd_confirmation ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "avc_emd_confirmation",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "avc_emd_confirmation"
}
Headers
Content-Type: application/JSON
Body
{}
guarantee_hotel_confirmed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "guarantee_hotel_confirmed",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "guarantee_hotel_confirmed"
}
Headers
Content-Type: application/JSON
Body
{}
name_corrected ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "name_corrected",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "name_corrected"
}
Headers
Content-Type: application/JSON
Body
{}
passengers_detail_changed ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "passengers_detail_changed",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "passengers_detail_changed"
}
Headers
Content-Type: application/JSON
Body
{}
duplicity_booking ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "duplicity_booking",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "duplicity_booking",
"original_bid": 8319
}
Headers
Content-Type: application/JSON
Body
{}
medical_certificate ¶
Headers
Content-Type: application/JSON
Body
{
"bid": 3649570,
"type": "medical_certificate",
"mmb_link": "https://www.kiwi.com/en/account/bookings/BID?deeplink=passengers-edit",
"trigger": "medical_certificate"
}
Headers
Content-Type: application/JSON
Body
{}
Generated by aglio on 13 Jul 2022