OpenCX supports multiple FareHarbor connections per organization — one per location, brand, or currency account. Each connection has its own API keys and its own AI action toggles.
Prerequisites
FareHarbor API partner account
FareHarbor API partner account
You need an App Key and a User Key issued by FareHarbor. These authenticate every request OpenCX makes to the FareHarbor API on your behalf. Contact FareHarbor to register as an API partner if you do not already have keys.
Currency-matched User Key
Currency-matched User Key
If you work with FareHarbor companies in different currencies (USD, NZD, EUR, etc.), you will have a separate User Key for each currency. Add one connection per currency — the AI will route each booking to the right connection automatically.
Setup
Open the FareHarbor add-on
In your OpenCX dashboard, go to Settings → Add-ons and select FareHarbor.
Add a connection
Click Add Connection. If you already have connections configured, they are listed here — you can add more by clicking the button again.
Give the connection a name
Enter a connection name that reflects what this connection is — for example
Downtown Location, USD Account, or RealNZ. The name is what your AI agent uses to disambiguate between connections during customer conversations, so pick something meaningful.Choose your environment
Toggle Sandbox Mode on for testing. This points the connection at FareHarbor’s demo environment — no real bookings, no real charges.
Enter your API keys
Paste your App Key and User Key. OpenCX validates both keys immediately by calling the FareHarbor API to list your affiliated companies. If validation fails, double-check that the keys are correct and that the User Key matches the currency of at least one affiliated company.
Select a default company
After key validation succeeds, a dropdown appears with the companies affiliated with this User Key. Pick the company you want this connection to book for. If there is only one, it is selected automatically.You can also leave this as Auto-detect — the AI will use the first company returned by the FareHarbor API for this connection.
Managing connections
Each connection has its own settings panel, reached by clicking it in the connection list:- AI actions — eight toggleable capabilities (list items, check availability, validate booking, create booking, get booking, cancel booking, generate payment link, send payment link via SMS). Each connection has its own toggles, so you can allow bookings on one location while keeping another read-only.
- Disconnect — removes just that connection. Other connections remain active.
How the AI picks the right connection
When you have more than one connection, every FareHarbor tool call the AI makes includes a location parameter — which connection to use. The AI resolves this automatically whenever it can:- If the customer mentions a specific company, tour, or region that maps to one connection, the AI uses it without asking.
- If the request is ambiguous (e.g. “what tours do you have?”), the AI asks the customer which location or brand they are interested in.
location parameter and no disambiguation — behavior is identical to a single-connection setup.
Disconnecting
To remove a single connection, open it from the connection list and click Disconnect. This removes:- The stored API keys for that connection
- The AI action settings for that connection
Related Documentation
Troubleshooting
Connection failures, missing availability, SMS delivery.
Booking Flow
How each AI action works day-to-day.
Overview
Capabilities, supported channels, and how it all fits together.
Chat
Booking experience in chat widget, WhatsApp, and SMS.