Setting Up API-Key Based Integrations
Documentation Team
Updated 2 months ago
API key-based integrations allow you to seamlessly sync data and automate review requests. These integrations can be set up by following the instructions below.
1. Access the Integration Page
- Go to Administration > Connections to open the Connections page.
- Navigate to the Browse tab.
- Find the desired integration card and click on it.
2. Explore the Marketing Page
- You'll be taken to the marketing page for the selected integration.
- This page provides detailed information about the integration's features and capabilities. For example, the marketing page for Gingr explains its functionality.
- Click the Connect button to start the setup process. This will open the pre-connect form.
3. Complete the Pre-Connect Form
- The pre-connect form outlines the next steps for setting up the integration.
- Click Add Connection to initiate the connection process.
4. Set Up the Connection
- After submitting the form, you'll be directed to the Connection Settings page. Here, you'll find setup instructions to complete the connection.
- For example, with Gingr, you’ll receive an API key that needs to be copied into the Location ID field in Gingr.
- Once the setup is complete, customer data will sync to the platform the first time a customer checks out a reservation in Gingr.
5. Confirm Connection Completion
- After the connection is successfully set up, you'll be notified via email and in-app notification.
- On the connection settings page, you can define preferences, such as enabling or disabling customer data syncing and automated review requests.
Note: Sending automated review requests requires a Reputation Management Premium subscription. Without this subscription, the option to enable review requests will be locked on the pre-connect form. This feature can be unlocked by purchasing the subscription.
- The newly set up connection will appear as a connection card in the Manage tab of the integration page and the marketing page, marked with a “Connected” tag.
6. Manage the Integration
- The integration will be displayed in the Manage tab via connection cards.
- Connection cards indicate the integration status:
- - Green checkmark: Connected
- - Yellow warning: Issue with the integration
- - Blue info: Integration setup in progress
- Before setup is completed, the integration will have a “Pre-Connected” status, highlighted by a banner in the Manage tab and an info symbol on the connection card.
- Users can click the connection card to access the connection settings page and continue the setup process. The “Pending Connection” status will also appear on the connection settings and marketing pages.
7. Troubleshooting
If you encounter issues during setup or while using the integration, contact Support for assistance.
Similar Setup Processes Are Followed By:
- Pet Resort Pro
- Protractor/Mitchell Enterprise
- RB Control Systems
- Field Edge
- JobNimbus
Articles in this section
- Setting up the QuickBooks Integration
- Setting Up Triggers for Closed Matters in Clio
- Add Valid API Users in ServiceMonster
- Setting Up Vendor-Managed Integrations
- Setting Up SSO-Based Integrations
- Setting Up API-Key Based Integrations
- Gingr Integration
- Connect Google Analytics
- Quickbooks Integration
- Connections Page
