Holibob Webhook API (1.0.0)

The first name of the consumer, only. Example: Charlie

The partner's unique reference of the consumer

All phone numbers must be added in the E.164 format to be considered valid. We are using https://www.npmjs.com/package/google-libphonenumber library for validation.* numbers should start with a '+'

• followed by country code
• the phone number

For example:

• USA: +14155552671
• Brazil: +551155256325
• UK: +442071838750

The email address of the consumer

The nationality of the consumer. It takes country codes in ISO 3166-1 alpha-2 standard

The preferred currency of the consumer. For example USD, EUR

ISO 639-1 language code

The partner's unique reference of the consumer's trip and or booking

The arrival date of the consumer's trip. The datetime that the consumer arrives at the destination. Timezone is required when passing a datetime string. Correct datetime string should follow ISO 8601 standard with timezone.

For example

• 2024-06-14
• 2024-06-14T07:27:17.335Z
• 2020-01-01T00:00:00.123+0200

If the request only have consumerTripArrivalDate that means it is a one-way trip

The return date of the consumer's trip. The datetime that the consumer returns from the destination. Timezone is required when passing a datetime string. Correct datetime string should follow ISO 8601 standard with timezone.

For example

• 2024-06-14
• 2024-06-14T07:27:17.335Z
• 2020-01-01T00:00:00.123+0200

If the request have both consumerTripArrivalDate and consumerTripReturnDate that means it is a round trip

The departure city name for the outbound journey

The departure country name for the outbound journey

The departure airport code for the outbound journey

The flight number for the arrival journey. For example: QF9

The flight number for the outbound journey. For example: BA 222

The flight class for the outbound journey

The datetime that the consumer made a booking on the partner's system

The partner's link for the consumer to view their booking. This is often a link to a manage my booking page

The name of the accommodation where the consumer is staying during their trip. This is often a hotel name

The address of the accommodation where the consumer is staying during their trip

The name of some venue that the consumer will attend during their trip

The address of some venue that the consumer will attend during their trip

The name of the destination where the consumer's trip is. This is often a city name. This field is case insensitive.If using consumerTripDestinationName, both consumerTripDestinationName and consumerTripDestinationCountryName must be used.

The name of the destination's country

The destination airport code for the return journey

The arrival airport name for the return journey

The departure airport name for the return journey

The partner's name for the product that was booked on their system. This is often the name of a hotel room, flight or event

The number of people in total on the consumer's trip

The number of children on the consumer's trip

The number of infants on the consumer's trip

Indicates whether the destination of the consumer's trip is international

Indicates whether the destination of the consumer's trip is within a day's travel from their home and unlikely to be a holiday destination

Indicates whether the destination of the consumer's trip is local to them

Your unique agent reference.

This field is required once any other agent data is provided

Agent email.

Once this field is provided then agentPartnerExternalReference field is required.

Timezone identifier from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Example: `America/New_York`, `Europe/London`

Once this field is provided then agentPartnerExternalReference field is required.

All phone numbers must be added in the E.164 format to be considered valid. We are using https://www.npmjs.com/package/google-libphonenumber library for validation.* numbers should start with a '+'

• followed by country code
• the phone number

For example:

• USA: +14155552671
• Brazil: +551155256325
• UK: +442071838750

Once this field is provided then agentPartnerExternalReference field is required.

Agent given name. Example: John.

Once this field is provided then agentPartnerExternalReference field is required.

The first name of the consumer, only. Example: Charlie

The partner's unique reference of the consumer

All phone numbers must be added in the E.164 format to be considered valid. We are using https://www.npmjs.com/package/google-libphonenumber library for validation.* numbers should start with a '+'

• followed by country code
• the phone number

For example:

• USA: +14155552671
• Brazil: +551155256325
• UK: +442071838750

The email address of the consumer

The nationality of the consumer. It takes country codes in ISO 3166-1 alpha-2 standard

The preferred currency of the consumer. For example USD, EUR

ISO 639-1 language code

The partner's unique reference of the consumer's trip and or booking

The arrival date of the consumer's trip. The datetime that the consumer arrives at the destination. Timezone is required when passing a datetime string. Correct datetime string should follow ISO 8601 standard with timezone.

For example

• 2024-06-14
• 2024-06-14T07:27:17.335Z
• 2020-01-01T00:00:00.123+0200

If the request only have consumerTripArrivalDate that means it is a one-way trip

The return date of the consumer's trip. The datetime that the consumer returns from the destination. Timezone is required when passing a datetime string. Correct datetime string should follow ISO 8601 standard with timezone.

For example

• 2024-06-14
• 2024-06-14T07:27:17.335Z
• 2020-01-01T00:00:00.123+0200

If the request have both consumerTripArrivalDate and consumerTripReturnDate that means it is a round trip

The departure city name for the outbound journey

The departure country name for the outbound journey

The departure airport code for the outbound journey

The flight number for the arrival journey. For example: QF9

The flight number for the outbound journey. For example: BA 222

The flight class for the outbound journey

The datetime that the consumer made a booking on the partner's system

The partner's link for the consumer to view their booking. This is often a link to a manage my booking page

The name of the accommodation where the consumer is staying during their trip. This is often a hotel name

The address of the accommodation where the consumer is staying during their trip

The name of some venue that the consumer will attend during their trip

The address of some venue that the consumer will attend during their trip

The name of the destination where the consumer's trip is. This is often a city name. This field is case insensitive.If using consumerTripDestinationName, both consumerTripDestinationName and consumerTripDestinationCountryName must be used.

The name of the destination's country

The destination airport code for the return journey

The arrival airport name for the return journey

The departure airport name for the return journey

The partner's name for the product that was booked on their system. This is often the name of a hotel room, flight or event

The number of people in total on the consumer's trip

The number of children on the consumer's trip

The number of infants on the consumer's trip

Indicates whether the destination of the consumer's trip is international

Indicates whether the destination of the consumer's trip is within a day's travel from their home and unlikely to be a holiday destination

Indicates whether the destination of the consumer's trip is local to them

Your unique agent reference.

This field is required once any other agent data is provided

Agent email.

Once this field is provided then agentPartnerExternalReference field is required.

Timezone identifier from https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Example: `America/New_York`, `Europe/London`

Once this field is provided then agentPartnerExternalReference field is required.

All phone numbers must be added in the E.164 format to be considered valid. We are using https://www.npmjs.com/package/google-libphonenumber library for validation.* numbers should start with a '+'

• followed by country code
• the phone number

For example:

• USA: +14155552671
• Brazil: +551155256325
• UK: +442071838750

Once this field is provided then agentPartnerExternalReference field is required.

Agent given name. Example: John.

Once this field is provided then agentPartnerExternalReference field is required.