New Connection Process for Other Teams
Last updated: August 12, 2025
Overview
This page explains the Connectivity Team’s process for connecting new client’s Dashboards to Online Travel Agencies (OTAs) via API. It’s written for internal FareHarbor Teams who want to understand the workflow.
For general questions please review the Channel Overview in the #connectivity Slack room and the Connectivity Hub for Other Teams help page.
Key Terms
- OTA: Online Travel Agency
- API: A technical interface that lets software systems (like FareHarbor & OTAs) talk to each other.
- API Types:
- Channel API: OTAs that FareHarbor develops the connection to. These are Viator/TripAdvisor Experiences, GetYourGuide, Google Things to do, Expedia, and Airbnb Experiences
- External API: Partner develops the connection and pulls inventory, availability, and other features at their discretion from FareHarbor. The Glossary is linked here.
- NC: An internal shorthand for a new API connection. New connections are not yet connected to the API, meaning that bookings are emailed directly to the client directly from the OTA (or their past reservation system) and must be manually entered into FareHarbor.
Process Summary
| Phase | What Happens | Who’s Involved |
|---|---|---|
| 0. Pre-Go Live | Affiliates added to Dashboard. Reservation transfers handled. | Onboarding Team, Account Executives |
| 1. Set Up | API Connectivity Team notified. Client contacted with next steps. | API Connectivity Team |
| 2. Mapping | Match products between OTA & FareHarbor. Submit for quality control check. | API Connectivity Team |
| 3. Go Live | API mapping finalized & client informed. | API Connectivity Team |
Phase 0: Pre Go-Live
Sales Role in New Connections
- API Fee Discussion: Encourage client to opt-in before go-live. Integrations cannot be set up until this is complete.
- Set Expectations: Check emails. Connectivity will email you within 24 hours of going live. While we strive to minimize disruptions, some downtime is unavoidable. Certain processes are not instantaneous and may be beyond our immediate control.
All Clients (T0+)
The OB Team adds Affiliates that the client works with to the Affiliates section of the client Dashboard. In addition, OB/AE handles reservation transfers and client communications before the client Dashboard goes live.
Note: Once an API booking is transferred into FareHarbor, the API connection that used to exist between that old reservation system and the OTA is “broken,” meaning that cancellations and amendments made to that booking through the OTA would no longer be reflected via API. The client must therefore update the OTA booking and the FareHarbor booking.
Enterprise Clients (T4+)
For Enterprise Dashboards that require mapping preparation before the Dashboard goes live, please tag the Enterprise Connectivity Team (@eyes_on_the_prize) in the shortname’s Slack room.
For Channel API partners:
- A list of the Channel OTAs the client wants to connect to
- A list of FareHarbor items that need to be mapped & to which specific OTA products they will need to be connected to
- (Optional) Corresponding OTA product page links for the FH items they would like to connect
- These are helpful so that our team can compare the setup of OTA products to FH items.
- Note: Please do not collect OTA login information from clients as we are not able to login to accounts due to two-factor authentication.
For External API partners:
- External API partners do not need mapping preparation ahead of time as API permissions and commissions are added by the FareHarbor Connectivity Team at go-live and the OTA partner finalizes the connection from there.
Phase 1: Set Up
When a client Dashboard with API Affiliates goes live, a Zendesk email is sent to the API Connectivity Team (triggers are per shortname).
- Note: If affiliates are added after a client’s Dashboard goes live, the Connectivity Team won’t get an automated Zendesk email. The OB/AE should then create a ticket for the Connectivity Team to proceed with the new connection.
The Connectivity Team reviews the list of Affiliates in the Dashboard and reaches out to the first POC listed in Close to provide them with next steps of each API connection.
- Channel APIs (Viator, GetYourGuide, Airbnb, Google, Expedia, Website Travel) are handled by the New Connection Team.
- External APIs are supported by the External Connectivity Team (@exterminators on Slack) but please note that External API mapping is completed by the OTA partner. FareHarbor only adds API permissions to the affiliate and the partner completes the connection from there.
Mapping an API connection is a complex process! Clients should be prepared to answer emails from the Connectivity Team during the mapping process.
We cannot provide connection completion dates due to factors like client volume, product count, and client response times. To make sure their connections can go live as quickly as possible:
- Clients should be prepared to respond promptly to emails from the Connectivity Team, since they may have important calls-to-action or questions about their setup.
- Clients should set up all of their OTA products before asking the Connectivity Team to initiate an API connection.
To facilitate a smooth API connection, clients should create their OTA products so that they match their FareHarbor items. It’s especially important that start times and customer types match as closely as possible to what they have in FareHarbor.
Phase 2: Mapping
A Connectivity Agent claims the Airtable record for the connection, ideally claiming all OTA connections for a client to prevent communication issues.
The Connectivity Agent matches the client’s FareHarbor item(s) with its corresponding OTA product(s) to create a ‘mapping file.’ This mapping file is managed solely by the Connectivity Team. Client communication is documented via linked Zendesk tickets in the Airtable file.
When and how should an escalation to the Connectivity Team occur?
- If a client is threatening to leave FareHarbor because of an API issue
- The client is expressing extreme dissatisfaction with Connectivity service
After submitting a ticket, AM/OB/AE can use the Escalations workflow in the #connectivity Slack room to have escalations addressed ASAP.
If the request is not an escalation, but is time sensitive, please link the ticket using the Submit a Question workflow and ask for the ticket to be expedited. If you do not have a ticket number, please link any correspondence you have had with the client (e.g. Close).
Phase 3: Go-Live
When the API mapping is complete, the agent will submit the mapping for a quality control check.
Once the check is completed and changes are actioned as needed, the connectivity agent will send the client a ‘go live’ email in Zendesk.
- Viator, Airbnb, Google: Set live by FareHarbor
- Expedia, Website Travel: Set live by the OTA
- GetYourGuide: Set live by the client
The agent will then mark the integration as “live” in the Airtable record, update the Connectivity-Live field in Close, and ping the AM/OB4 in Slack using the API Live workflow.
Bookings made before the API went live must be entered into the Dashboard manually.