# Notify about booking creation

**POST /booking-event/create/{secret}**

Notify about booking creation


## Servers
- Production server: https://webhook.production.holibob.tech (Production server)



## Parameters

### Path parameters
- **secret** (string)
  Security secret received from Holibob


### Body: application/json (object)

- **consumerGivenName** (string | null)
  The first name of the consumer, only. Example: `Charlie`
- **consumerPartnerExternalReference** (string | null)
  The partner's unique reference of the consumer
- **consumerPhone** (string | null)
  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`
- **consumerEmail** (string(email) | null)
  The email address of the consumer
- **consumerNationality** (string | null)
  The nationality of the consumer. It takes country codes in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) standard
- **consumerCurrency** (string | null)
  The preferred currency of the consumer. For example `USD`, `EUR`
- **consumerLanguage** (string | null)
  ISO 639-1 language code
- **consumerTripPartnerExternalReference** (string)
  The partner's unique reference of the consumer's trip and or booking
- **consumerTripArrivalDate** (string(date) | string(date-time))
  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](https://en.m.wikipedia.org/wiki/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
- **consumerTripReturnDate** (string(date) | string(date-time))
  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](https://en.m.wikipedia.org/wiki/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
- **consumerTripDepartureCityName** (string | null)
  The departure city name for the outbound journey
- **consumerTripDepartureCountryName** (string | null)
  The departure country name for the outbound journey
- **consumerTripDepartureAirportCode** (string | null)
  The departure airport code for the outbound journey
- **consumerTripArrivalFlightNumber** (string | null)
  The flight number for the arrival journey. For example: QF9
- **consumerTripDepartureFlightNumber** (string | null)
  The flight number for the outbound journey. For example: BA 222
- **consumerTripDepartureFlightClass** (string | null)
  The flight class for the outbound journey
- **consumerTripBookingDate** (string(date) | string(date-time))
  The datetime that the consumer made a booking on the partner's system
- **consumerTripBookingLink** (string(uri) | null)
  The partner's link for the consumer to view their booking. This is often a link to a manage my booking page
- **consumerTripAccommodationName** (string | null)
  The name of the accommodation where the consumer is staying during their trip. This is often a hotel name
- **consumerTripAccommodationAddress** (string | null)
  The address of the accommodation where the consumer is staying during their trip
- **consumerTripVenueName** (string | null)
  The name of some venue that the consumer will attend during their trip
- **consumerTripVenueAddress** (string | null)
  The address of some venue that the consumer will attend during their trip
- **consumerTripDestinationName** (string | null)
  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.
- **consumerTripDestinationCountryName** (string | null)
  The name of the destination's country
- **consumerTripDestinationAirportCode** (string | null)
  The destination airport code for the return journey
- **consumerTripArrivalAirportName** (string | null)
  The arrival airport name for the return journey
- **consumerTripDepartureAirportName** (string | null)
  The departure airport name for the return journey
- **consumerTripExternalProductName** (string | null)
  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
- **consumerTripPersonCount** (integer | null)
  The number of people in total on the consumer's trip
- **consumerTripChildCount** (integer | null)
  The number of children on the consumer's trip
- **consumerTripInfantCount** (integer | null)
  The number of infants on the consumer's trip
- **consumerTripIsInternational** (string | null)
  Indicates whether the destination of the consumer's trip is international
- **consumerTripIsRegional** (string | null)
  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
- **consumerTripIsLocal** (string | null)
  Indicates whether the destination of the consumer's trip is local to them


## Responses
### 200
Success

#### Body: application/json (object)
- **success** (boolean)
  Indicates if the operation was successful

### 403
Returned when provided secret is invalid

#### Body: application/json (object)
- **message** (string)


### 422
Returned when one of validation rules has been violated

#### Body: application/json (object)
- **message** (string)

- **violationList** (array[object])



[Powered by Bump.sh](https://bump.sh)