The information contained in this document is confidential, privileged, and only for the use of internal Birdeye users. This document may not be used, published or redistributed.
This integration supports both SMB & Enterprise businesses.
Integrating Birdeye with OpenTable®
User Manual - SUPPORT ARTICLE
OpenTable is a cloud-based restaurant management solution which offers various features, including online reservation, restaurant marketing, data analytics, training and support to restaurant managers. OpenTable is available for restaurant managers in Guest Center and Connect.
Once Birdeye is integrated with OpenTable, Birdeye will pull data pertaining to customers who visited the day before. Birdeye collects the first name, last name, email address and phone number of your customers securely and automatically sends them review requests based on the preferences set within the Birdeye dashboard.
Table of Contents
Triggers Supported
Information required from Birdeye client
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers supported
Birdeye allow you to fetch data from your CRM using predefined triggers. As part of the integration process, you will need to ask the business for its preference. After the integration is complete, requests will be sent based on the configured trigger. Here is the supported trigger for OpenTable:
Trigger Display Name | Trigger Name/ Value | Trigger Description |
OpenTable Visited Customer Trigger | Visited Customer | This trigger is used to fetch customer data based on restaurant visits. |
Details required from the Birdeye client
Trigger Details
Authentication ID
Username, Password and Account ID of Guestcenter
You also need to Sign Out of the Open Table Window before creating/updating the integration, so copy it and click on Sign Out.
You can access this browser section as follows for the following popular browsers:
Firefox: Tools -> Web Developer -> Storage Inspector -> Cookies
Chrome: View -> Developer -> Developer Tools -> Application -> Cookies.
How to Sign out from Open Table
Details required from the Birdeye dashboard
Enterprise ID for a multi-location account and Business ID for all locations.
Business ID in case of an SMB Business.
Information from Birdeye Dashboard
For single location SMB account - Business ID
Login to your Birdeye account, go to Left Navigation Rail and click on ‘Settings’. Once the new page appears, click on ‘Integrations’ and select ‘API.’
You will find the ‘Business ID’ and ‘API key’ shown in the image.
For multi-location accounts - Enterprise ID and Business IDs of all locations
Enterprise ID
Business IDs of all locations
Login to your Birdeye account, go to Left Navigation Rail and click on ‘Settings’. Once the new page appears, click on ‘Profile’ and select ‘Business Profiles.’
To view the Location ID, hover over the ‘Status’ of the location.
Integration process
Before you can integrate OpenTable with Birdeye, you will need to set up the following configurations on the integration support dashboard:
To set up native integration, we have an integration support dashboard, where we need to set up the integration and then follow these steps to complete the configuration.
Login
After successful login in the integration dashboard, you have to click on ‘BE integration’ and then click on ‘Add Integration’.
Search for the CRM in the search bar and select it. Click on ‘Next’.
Manage Triggers
The trigger is automatically selected as only one trigger is supported.
Note: To fetch information for all the triggers available using curl commands, use this command. To replace triggers, use this curl command.
Manage Properties
Here; you can manage group-level properties, which will be applied to all locations under a CRM.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Authentication ID: Provide authentication ID.
Note: This step will create a group for our integration. Alternatively, you can do it via curl commands.
For SMB accounts, you can access the curl command.
For Enterprise accounts, you can access the curl command.
Manage Locations
For Single Location/Multi-Location Accounts, select the location from the drop-down menu and click on ‘Add.’
(In the case of Single Location accounts, it will give you only one option).
A drawer will appear on the right-hand side.
The Status, Frequency, and Next Runtime will be set by default. You can make the changes if required.
Status: It shows the status of Integration (Active or Inactive).
Frequency: The number of times integration will sync with CRM (Days or Hours).
Next RunTime: It is the next scheduled time when the integrations will run.
User Name, Password and Account ID: These details will be shared by a customer in the initial setup call.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Override Group Properties: With this, you can override the properties added at the group level, specific to each location.
Click on ‘Next’ and click on ‘Save.’
NOTE:
For SMB: You can use ‘manage the locations’ using this curl command.
For Enterprise: You can use ‘manage the locations’ using this curl command.
Curl Commands
Before you can integrate OpenTable with Birdeye, you will need to set up the following configurations:
A business integration group is a configuration that supports the business hierarchy of individual businesses on the Birdeye platform. The properties that are common for all business integrations are entered at the group level. Setting up a business integration group allows you to associate multiple business locations with the Enterprise account. Below is the list of curl commands you will need to run to set this up.
Find business integration group details (Curl Command)
Copy Curl Command:
curl-X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/149495303607205 -H 'Cache-Control: no-cache'
149495303607205- Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account.
Sample response:
[{"groupId": 1685,"integrationSourceType": {"id": 37,"integrationSource": "OPENTABLE","sourceCategory": "Restaurant","integrationType": "Birdeye API","oauthEnabled": false},"integrationGroupTriggers": [{"triggerId": 59,"triggerTypeId": 1,"actionIds": [1]}]}]1685- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
Create Integration Group (Curl Command)
Copy Curl Command:
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'content-type: application/json' -d '{ "parentBusinessNumber": 149495303607205,"integrationSourceId": 37, "integrationGroupProperties": [ { "propertyKey": "opentable.authentication.id","propertyValue":"70E7F0226C6AB7","isSecure": true}],"integrationGroupTriggers":[{"triggerId":59, "triggerTypeId":1}]}'149495303607205- Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account.
59- Integration Trigger ID - Can be one or more triggers. Ask clients what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for Open Table. Identify the trigger ID (s) and insert (use commas) in case of multiple trigger IDs.
70E7F0226C6AB7- opentable.authentication.id - This is OpenTable authentication ID. If, in future, it expires, follow the below screenshot for the ID (look for the key with the name otumamiauth).
Fetch information for all the triggers available for OpenTable (Curl Command).
Copy Curl Command:
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/37 -H 'cache-control: no-cache' -H 'content-type: application/json'
Sample response: A sample response like this would appear after you run the curl command. The response will have the trigger name, description and ID. This trigger ID will be utilized while creating the integration group. Integration can have one or more triggers. To use more than one trigger, enter comma-separated values while creating the integration group.
[{"id": 59,"triggerService": "openTableTriggerService","displayName": "OpenTable Visited Customer Trigger","description": "This trigger is used to fetch customer data based on restaurant visits.","active": true,"integrationTriggerType": [{"id": 1,"name": "JOB"}],"actionGroupId": 1}]59- Trigger ID
Update Triggers Information (use only if business wants to change) (Curl Command)
Copy Curl Command:
curl -X POST 'https://common-services.Birdeye.com/integration/update/businessintegrationgroup?replaceTriggers=true' -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "groupId": 1685,"integrationGroupTriggers":[{"triggerId":59,"triggerTypeId":1}]}'replaceTriggers=true - To replace existing trigger(s), enter the value for replaceTriggers as To add a new trigger(s) to the existing list, the value for replaceTriggers should be false
1685- The Group ID that was returned in the previous step will be entered here.
59- Enter the Trigger ID(s) that need to be added or updated to the integration.
Integration Mapping
Once the Integration Group is created, the next step is to create the Integration Mapping.
Copy Curl Command:
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'content-type: application/json' -d '{ "businessNumber": 149495303607205,"integrationGroupId": 1685, "active": true, "integrationProperties": [{"propertyKey" : "ot.username","propertyValue": "info@jprimesteakhouse.com","isSecure":false},{
"propertyKey" : "da.password","propertyValue": "Blanco1604","isSecure":false},{
"propertyKey" : "da.business_id","propertyValue": "267502","isSecure":false}
]}'
149495303607205- Business Number: Enter the Business number here
1685- Integration Group ID: Enter the Integration Group ID, which was returned when the Integration group was created.
info@jprimesteakhouse.com - Username: The Username will be shared by a customer in the initial setup call.
Blanco1604 - Password: The Password will be shared by a customer in the initial setup call.
267502 - Account ID: The Account ID will be shared by a customer in the initial setup call.
How to Sign out from Open Table
Possible Error And Resolution at Support End
{"data":[],"error":{"code":101,"message":"Opentable error for Username : bfogelsong@clancysinc.com, Message : Navigation Timeout Exceeded: 30000ms exceeded"}}
Timeout Exceeded Error: One of the use-cases of this error would be if you have forgotten to Sign out of Open Table after copying the otumamiauth (Authentication ID) from the Open Table and saved/updated the integration.
Always remember to Sign Out(do not close the window until clicking on Sign out) and then paste the copied Authentication ID on the Integration Dashboard.{"data":[],"error":{"code":101,"message":"Opentable error for Username : bfogelsong@clancysinc.com, Message : Authentication Failed!"}}
Authentication Failed: Credentials are Incorrect; update with the correct credentials.