Consumer Trip Data Ingestion - WebHooks and structured URL's
This document outlines the methods by which you can pass consumer trip data to Holibob to personalise the user experience for individual travellers and cross-sell targeted things to do. This means if the consumer is travelling to London with their Children, we will render a family-friendly shelf on the London Destination Page.
For Developers, you can see a link to our WebHook technical documentation here - https://webhook.documentation.holibob.tech/operation/operation-post-booking-event-create-parameter
Method / Mechanism | When would you use this | Advantages | Limitations |
|---|---|---|---|
Webhook PREFFERED | This method allows our partners to send customer booking data to Holibob when they confirm, cancel or amend a booking for their original purchase via your brand. (Flight, hotel, other travel product) Best used when: Holibob markets to these consumers on our partner's behalf via WhatsApp close to the travel date / in-destination to maximise conversion. | Allows partners to reap the full benefit of the Holibob personalisation engine. Holibob can power marketing automation on your behalf. Holibob can filter consumers based on available destinations. Real-time updates on booking creation, modification, and cancellation. | Not applicable if marketing tours and experiences before your consumer has made a booking (flight / hotel etc.) |
Url Params / Structured URL ALTERNATIVE | Partners can easily embed a structured URL across your booking journey and existing pre and post-booking touch points. For example, booking confirmation screens, voucher emails etc. Best used when: Promoting experiences pre-booking or in placements in existing booking journey. | Smaller engineering lift Only need to send data at time of consumer clocking the link | We may not cover 100% of the destinations you serve, therefor we would land the consumer on the global experience, enabling them to select their destination of interest. |
Webhooks
Utilising Webhooks allows our partners to pass data at the point a consumer makes an initial purchase via your brand, leaving Holibob to deliver the personalised consumer experience. We set up webhook endpoints for our partners to send booking events in real-time, including updates on booking creation, modification, and cancellation. This means we won’t market to any consumers who have changed or cancelled their booking.
Timing:
We advise partners to send trip data as soon as the booking is made on their side. E.g:
a flight is booked
a hotel is booked
This enables us to not miss opportunities to market to customers who book at the last minute.
Implementation
Architecture
Partner system sends us booking events in real-time
Partner events are sent to a Holibob API
Holibob markets to consumers close to the travel date
Events
We typically set up three endpoints for the following events:
Event | Use | Importance |
|---|---|---|
Booking Create | When the consumer creates a new booking | Scheduling marketing and personalising UX |
Booking Update | When the consumer updates any information on an existing booking | Ensure we do not personalise experience based on stale data |
Booking Cancel | When the consumer cancels a booking | Ensure that we do not send any marketing when trip has been cancelled |
You can see the technical documentation on events here - https://webhook.documentation.holibob.tech/operation/operation-post-booking-event-create-parameter
Authentication
We do not require any authentication on our endpoints, making them easy to integrate with. They are protected by “security through obscurity” and kept hidden, even from us. The endpoint itself is treated as a secret and securely sent, as per the steps below:
Receiving your secret:
We use Bitwarden Send to securely send your secret.
You will receive an email that allows you to view your secret only once and times out after (24 hrs)
When you are ready, please co-ordinate with your partner success manager to initiate this process.
Example Secret: 12345678
Example endpoints:
Booking create: https://webhook.production.holibob.tech/booking-event/create/12345678
Booking Update: https://webhook.production.holibob.tech/booking-event/update/12345678
Booking Cancel: https://webhook.production.holibob.tech/booking-event/cancel/12345678
Url Parameters
The table below shows all of the parameters that can be passed on the URL:
https://holibob.atlassian.net/wiki/spaces/Solutions/database/2721513559?unsavedView=3293e58d-3ba8-4bf6-86a1-4e87257c6d29Example:
A two-week trip to Rome with Kids
URL Param Field | Example data |
|---|---|
consumerTrip.destinationName | Rome |
consumerTrip.arrivalDate | 2025-01-01 |
consumerTrip.departureDate | 2025-01-15 |
consumerTrip.childCount | 2 |
consumerTrip.personCount | 4 |