Skip to main content

Birdeye Native Integration - Zoho CRM

Updated in the last hour

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 only supported for SMB businesses.

NOTE: If there is an enterprise business to be set up and there are unique sign-in required for every location, such integration should be set up as an SMB i.e an integration group should be created for every location.

Integrating Birdeye with Zoho CRM
User Manual - SUPPORT ARTICLE

Zoho CRM is an online customer relationship management (CRM) platform used by small to large-sized organizations for managing sales, marketing, customer support and service in one platform. Integrating Zoho CRM with Birdeye will automate the process of sending out review requests to clients on a daily basis.

Once Zoho CRM is integrated with Birdeye, Birdeye will pull client information from Zoho CRM once daily. Birdeye collects the first name, last name, email address and phone number of your clients and automatically sends them review requests based on the preferences set within the Birdeye dashboard.

Table of Contents


Integration Requirements

Triggers Supported

Birdeye allows you to fetch data from your PMS using some predefined triggers. You can choose any combination from the list of available triggers and inform the support team about your selection. Here are the supported triggers for Zoho CRM:

TriggerDisplay Name

Trigger Name/Value

Trigger Description

Zoho CRM New Contact Trigger Service

New Contact

This trigger is used to fetch customer data from the new contacts.

Zoho CRM New Closed Deal Trigger Service

Closed Deal

This trigger is used to fetch customer data from the new closed deals.

Zoho CRM New Lead Trigger Service

New Lead

This trigger is used to fetch customer data from new lead

Birdeye Lead Trigger Service

Birdeye Lead

This trigger is used to push referral and webchat leads from Birdeye into the Zoho CRM.

Details required from the Birdeye Client

  • Trigger Details

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

  1. 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.


Integration Process

Before you can integrate Zoho 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

  1. After successful login in the integration dashboard, you have to click on ‘BE integration’ and then click on ‘Add Integration’.

  2. 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 (For each trigger): It is used if businesses want to send review requests with a delay (number of days).

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.

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 the changes if required.

  1. Status: It shows the status of Integration (Active or Inactive).

  2. Frequency: It is the number of times integration will sync with CRM (Days or Hours).

  3. Next RunTime: It is the next scheduled time when the integrations will run.

  4. 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.

Note: For SMB: You can use ‘manage the locations’ using this curl command.

Completing the Integration Process

To complete the integration, click on the 'Settings' tab located on the left navigation rail of your Birdeye dashboard. Click on the ‘Business Profile’ under the ‘Profile’ section.

Click on the specific location for which you have set up the integration.

Once you click on the particular location, it will redirect you to that location. Now, scroll down to the ‘CRM Integrations’, and click on the ‘Authorize’ button to authorize the business.

After you click on the authorization button, you will be redirected to the Zoho website. Enter the email address and password associated with your Zoho account and click on the 'Sign In' button.

Once you have signed in to your Zoho account, Birdeye will ask for certain permissions to obtain data from your Zoho account. Click on the 'Accept' button at the bottom to complete the integration process.

After the access has been granted, you will be redirected to the Birdeye dashboard, and integration will get 'Authorized'. Once you are successfully authorized with Zoho CRM, you can disconnect by clicking on the 'Disconnect Zoho CRM' button beside 'Authorized.’ Once you are disconnected, you will no longer be able to fetch customer information from Zoho CRM. You can reauthorize Zoho CRM by clicking ‘Authorize Zoho CRM.’

IMPORTANT: The user who performs the authorization steps must have the Zoho API permissions. To verify the permission settings, follow the steps detailed below:

  1. Log into your Zoho CRM account.

  2. Click on the ‘Settings’ icon on the top bar.

  3. On the next screen, click on the ‘Users’ button.

Now, you can view the user's list.

Note: You can view that the user’s profile is ‘Administrator.’

  1. Go to the ‘Security Control’ tab on the left panel.

  2. Now, click on the ‘Administrator’ profile.

  3. On the new screen, go to the ‘Developer Permissions’ section under the ‘Zoho’ tab on the left panel. Make sure that the ‘Zoho CRM API Access’ field is enabled.


Curl Commands

Before you can integrate Zoho CRM 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)

Copy Curl Command

curl-X PUT https://common-services.birdeye.com/integration/add/businessintegrationgroup -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "parentBusinessNumber" :150368129926468, "integrationSourceId" : 40, "integrationGroupTriggers":[{"triggerId":62,"triggerTypeId":1}]}'
  • 150368129926468 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account

  • 62 - 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 Zoho CRM. Identify the trigger Id(s) and insert (use commas) in case of multiple trigger IDs.

Fetch information for all the triggers available for Zoho CRM (Curl Command)

Copy Curl Command

curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/40 -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": 62,"triggerService": "zohoNewLeadTriggerService","displayName": "ZohoCrm New Lead Trigger Service","description": "This trigger is used to fetch customer data from new lead.","active": true,"integrationTriggerType": [{"id": 1,"name": "JOB"}],"actionGroupId": 1"id": 63,"triggerService": "zohoNewContactTriggerService","displayName": "ZohoCrm New Contact Trigger Service","description": "This trigger is used to fetch customer data from new contact.","active": true,"integrationTriggerType": [{"id": 1,"name": "JOB"}],"actionGroupId": 1},{"id": 64,"triggerService": "zohoNewClosedDealTriggerService","displayName": "ZohoCrm New Closed Deal Trigger Service","description": "This trigger is used to fetch customer data from new closed deal.","active": true,"integrationTriggerType": [{"id": 1,"name": "JOB"}],"actionGroupId": 1},{"id": 107,"triggerService": "birdEyeLeadTriggerService","displayName": "Birdeye Lead Trigger","description": "This trigger is used to create lead from Birdeye into Zoho CRM","active": true,"actionGroupId": 7}]
  • 62, 63, 64,107- Trigger IDs

Find business integration group details (Curl Command)

Copy Curl Command

curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/150368129926468 -H 'Cache-Control: no-cache'
  • 150368129926468 - Business ID: Enter the Business Id here to get the integration group details for a business.

[{"groupId":2164,"integrationSourceType":{"id":40,"integrationSource":"ZOHOCRM","sourceCategory":"CRM","oauthEnabled":true},"integrationGroupTriggers": [{"triggerId": 62,"triggerTypeId": 1}]}]2164 - 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 client wants a 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": 2164,"integrationGroupTriggers":[{"triggerId":62,"triggerTypeId":1}]}'
  • replaceTriggers=true -To replace existing trigger(s), enter the value for replaceTriggers as true. To add new trigger(s) to the existing list, the value for replaceTriggers should be false.

  • 2164 - Group ID: The Group ID which was returned in the previous step will be entered here.

  • 62 - 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 Curl Command

curl -X PUT https://common-services.birdeye.com/integration/add/businessintegrationmapping -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "businessNumber": 150368129926468, "integrationGroupId" : 2164, "active": true }'
  • 150368129926468 - Business ID: Enter the Business ID for the SMB Business.

  • 2164 - Group ID: Enter the Group ID, which was returned when the Integration group was created.


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 Zoho CRM are:

  1. Crm deals probability is not 100

  2. Integration is beta

Did this answer your question?