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 is supported for both SMB & Enterprise businesses
Integrating Birdeye with Zoho CRM
User Manual - SUPPORT ARTICLE
ABC Financial is a leading software and payment processing provider for the health and fitness industry, which allows gyms and health clubs to manage their billing services. Integrating ABC Financial with Birdeye will automate the process of sending out review requests to clients on a daily basis.
Once ABC Financial is integrated with Birdeye, Birdeye will pull customer information from ABC Financial once daily. Birdeye collects the first name, last name, email address, and phone number of your customers and automatically sends them to review requests based on the preferences set within the Birdeye dashboard.
Table of Contents
Triggers Supported
Information required from the Business
Information from Birdeye dashboard
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers Supported
Birdeye allows you to fetch data from your CRM using a predefined trigger. Here is the supported trigger for ABC Financial.
Trigger Display Name | Trigger Name/Value | Trigger Description |
ABC Financial Last Checkin Trigger | Member | This trigger is used to fetch customer data based on the last check-in timestamp of the members |
ABC Financial Member Trigger | Prospect Visit | This trigger is used to fetch the customer data based on prospect change of the members |
Request for the Integration with ABC Financial
To initiate the integration, get this form filled by the business, then send it to: apiactivation@abcfinancial.com.
Once the business approves and signs the agreement, you will receive an email from ABC Financial stating that Birdeye has been granted access to the requested club numbers.
NOTE: Please reach out to integration-support@Birdeye.com in case you don’t receive the email within 7 days.
Details required from the ABC Financial dashboard
Trigger details
ABC Financial Club Number
Details required from the Birdeye dashboard
Enterprise ID for the multi-location account.
Business ID for single location SMB account
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 Location ID, hover over the ‘Status’ of location.
Integration Process
Before you can integrate ABC Financial 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
Select the Trigger Name (Check Box) as per the client’s requirement and click ‘Next.’
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).
Client ID: For any non-Planet Fitness client, use the client id-a8092ca5 and for any Planet Fitness client, use this client id-eca0a1aa.
Client Secret: For any non-Planet Fitness client, use this secret key-cd960315286e0859a8cdf33403a1f707 and for any Planet Fitness client, use this client secret key- db8bcdf4c486ff3f838178d3a69dd2b3.
Please fill in the below details and click Next.
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 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 changes if required.
Office Id: Enter the Office Id.
Status: It shows the status of the integration (Active or Inactive).
Frequency: It is 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.
Enter the club number for this location: Enter the club number provided by the customer location.
Customer Fetch Delay: It is used if businesses want to send review requests with a delay (number of days).
Override Group Properties: The user can override any of the below-mentioned properties for a particular 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.
Authorize through Integration Dashboard
To set up through Integration Dashboard, follow these steps:
Once in the Integration dashboard, click on the ‘BE Integrations’ tab on the left navigation rail. Hover over the three dots next to ABCFinancial and click on ‘Edit.’
Once you click on the edit option, a screen will appear. Scroll down to ‘Locations’ to authorize the location.
Hover over three dots, and click the ‘Actions’ drop-down button.
Furthermore, click on the ‘Authorize’ button.
After clicking the authorize option, the location will be authorized.
Curl Commands
Before you can integrate ABC Financial 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 that you will need to run to set this up.
Create Integration Group (Curl Command) - For Non-Planet Fitness Clients
Copy this Curl Command
curl-X PUT https://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'content-type: application/json' \-d '{"parentBusinessNumber": 145591892655078, "integrationSourceId": 47,"integrationGroupProperties": [{"propertyKey": "app_id","propertyValue": "a8092ca5","isSecure": false}, {"propertyKey": "app_key","propertyValue": "cd960315286e0859a8cdf33403a1f707","isSecure": false}], "integrationGroupTriggers": [{"triggerId": 70,"triggerTypeId": 1},{"triggerId": 107,"triggerTypeId": 1}]}'145591892655078 - Business ID - This is Enterprise ID for the multi-location account and Business ID for a single location SMB account
a8092ca5 - App ID - For any non Planet Fitness client, use this app id.
cd960315286e0859a8cdf33403a1f707 - App Secret - For any non Planet Fitness client, use this app secret.
Create Integration Group (Curl Command) - For Planet Fitness Client
Copy this Curl Command
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'content-type: application/json' \-d '{"parentBusinessNumber": 145591892655078, "integrationSourceId": 47,"integrationGroupProperties": [{"propertyKey": "app_id","propertyValue": "eca0a1aa","isSecure": false}, {"propertyKey": "app_key","propertyValue": "db8bcdf4c486ff3f838178d3a69dd2b3","isSecure": false}], "integrationGroupTriggers": [{"triggerId": 70,"triggerTypeId": 1},{"triggerId": 107,"triggerTypeId": 1}]}'145591892655078 - Business ID - This is Enterprise ID for the multi-location account and Business ID for a single location SMB account
eca0a1aa - App ID - For any Planet Fitness client, use this app id.
db8bcdf4c486ff3f838178d3a69dd2b3 - App Secret - For any Planet Fitness client, use this app secret.
Fetch information for all the triggers available for ABC Financial (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/47 -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": 70,"triggerService": "abcFinancialLastCheckinTriggerService","displayName": "ABC Financial Last Checkin Trigger","description": "This trigger is used to fetch customer data based on last checkin timestamp of the members .","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"caseCreationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [47],"triggerName": "Member"},{"id": 107,"triggerService": "abcFinancialProspectChangeTriggerService","displayName": "ABC Financial Prospect Change Trigger","description": "This trigger is used to fetch customer data based on prospect change of the members.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"caseCreationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [47]}]70, 107 - Trigger ID’sFind business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/145591892655078
145591892655078 - Business ID: Enter the Business ID here to get the integration group details for a business.
Sample:
{"groupId": 3988,"integrationSourceType": {"id": 47,"integrationSource": "ABCFINANCIAL","sourceCategory": "Fitness","integrationType": "Birdeye API","integrationPlan": "Basic","oauthEnabled": false},"integrationGroupTriggers": [{"triggerId": 70,"triggerTypeId": 1,"actionIds": [1]}, {"triggerId": 107,"triggerTypeId": 1,"actionIds": [1]}]}3988 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
Trigger Information: Only required if the client wants a change (Curl Command)
Copy this 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": 3988 ,"integrationGroupTriggers":[{"triggerId":70,"triggerTypeId":1}]}'replaceTriggers=true -To replace existing trigger(s), enter the value for replaceTriggers as true. To add a new trigger(s) to the existing list, the value for replaceTriggers should be false.
3988 - Group ID: The Group ID which was returned in the previous step will be entered here.
70 - Trigger ID: Enter the Trigger ID (s) which 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 this Curl Command:
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'content-type: application/json' -d '{"businessNumber": 146912668936954, "integrationGroupId": 3988, "active": true, "integrationProperties": [{"propertyKey": "club.number","propertyValue": "0423"}]}'146912668936954 - Business ID: Enter the Business ID for the SMB Business.
3988 - Group ID: Enter the Group ID, which was returned when the Integration group was created.
0423 - Club Number: This number will be provided by the client during the initial integration setup. (This will be unique to each Birdeye location.)
Appendix
Re-Authorise Business
Sometimes, it happens the credentials entered were wrong during setup or are expired, so we receive 401 Unauthorized Error while running the Integration, and as a result, Integration will be marked unauthorized. It will not run until the credentials are corrected and the business is authorized again, which involves the steps given in the below document.
Troubleshooting
If you want to raise an issue or seek support from ABC Financial, please raise the issue to partnersolutions@abcfinancial.com.
Restriction Reason
Restriction reason is used to identify the contacts who have been opted-out(restricted) from sending a review request. This reason can be fetched from Kibana for contacts that are checked in already.
Possible restriction reasons for ABC Financial are:
Member status is not active
Integration is beta
Description
Member status is inactive for this customer.
















