Additional information is available to FareHarbor employees.
Webhooks might be a good fit for your setup if you have the resources available to manage them. Your business (or a third party that is assisting) must develop the target integration, and then provide FareHarbor with the destination URL.
Your FareHarbor Dashboard can be configured to share booking and item data in a raw format via webhook, allowing you or a third-party partner to integrate the data into another platform for your specific needs.
Our webhooks export data in real-time, and are triggered whenever a booking is created, updated, or canceled. We offer webhooks that export booking and/or item data (such as when items are changed, added, renamed), as well as a webhook that exports specific payment information.
What is a webhook?
A webhook is a type of integration that allows FareHarbor to export booking data out of our system in real-time and send it to a third party. Webhooks are used for almost all integrations to in-house or third-party systems, and function as a one-way integration. For example, a webhook might be used to send data from FareHarbor to a specified third-party system, but not the reverse.
The Zapier integration also works like the webhook, and is a one-way integration only (from FareHarbor to Zapier). See our Zapier help page for more information on this integration.
Using webhooks
FareHarbor webhooks can be used to send both booking and/or item data to company, affiliate, and non-affiliate users when a booking is created or updated. For example:
- A company offering vouchers could use a webhook to see when their vouchers are redeemed. (Note: Visibility into gift cards, promo codes, or discount codes is not available.)
- Limited booking information (such as customer name, address, phone number and email address) could be sent to an email marketing company, contributing to possible email lists.
Booking-type webhooks can be utilized as automatic, mass exports of booking-level information sent out of FareHarbor to an external URL. Using a booking-type webhook is the easiest way to ensure a third-party has access to the most up-to-date booking and customer information from FareHarbor. See the Using webhooks help page for more details on what booking data can be used as API triggers.
Item-type webhooks connections offer item-level data. See the Using webhooks help page for more details on what item data can be used as API triggers.
Getting started
Please see the Configuring webhooks help page for step-by-step details on adding a webhook.
Once the webhook is set up and a booking is created or updated, a POST call is sent for all webhook URLs associated with the booking’s company (and, if it is an affiliate booking, the booking’s affiliate company). Data from these API calls are returned in JSON format.
Explore our Using webhooks help page for more granular information about using FareHarbor custom webhooks.
In the event of a timeout, connection issue, or error response, the webhook request is reattempted three times, with a 60-second delay between retries.
An entry is added to the activity log indicating the status of the request (succeeded or failed).