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.
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 Drchrono
User Manual - SUPPORT ARTICLE
DrChrono offers an integrated electronic health record (EHR), practice management and medical billing platform. The platform is available for users on iPhones, iPad, and the web. Integrating DrChrono with Birdeye will automate the process of sending out review requests to patients on a daily basis.
Once DrChrono is integrated with Birdeye, Birdeye will pull patient data for the appointments that were completed on the previous day. Birdeye collects the first name, last name, email address and phone number of your patients and automatically sends them review requests.
Table of Contents
Triggers Supported
Information required from the Business
Required Permission
DrChrono Office ID
Enterprise ID for a multi-location account and Business Id for all locations.
Business ID in the case of an SMB business
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 DrChrono:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Dr Chrono Appointments Trigger | Dr Chrono Appointment | This trigger is used to fetch customer data based on the completed appointments. |
Details required from the DrChrono dashboard
Trigger details
DrChrono Office ID
Before the initial setup, the authorizing user for the DrChrono account needs to grant FOUR required permissions for Birdeye to fetch patient data successfully.
How to grant permissions within your DrChrono account:
To grant permissions for data transfer, hover over the 'Account' tab on the panel and from the drop-down menu, click on the 'Staff Permissions' button.
Once on the 'Permissions Administration' page, click on the 'Staff' section. Now, click on the 'View' button, which appears next to the authorizing user.
To edit permissions for the authorizing user, click on the 'Edit Permissions' button on the bottom right.
Now, check the box which appears next to the four required permissions - Access Billing, Show Billing Tab, Access Clinical Notes, Manage Patients - and click on the 'Save Permissions' button to save your selection.
To locate the office ID in your DrChrono account, follow the steps detailed below:
Navigate to drchrono.com and 'Log In' to your DrChrono account.
Once you have logged in to your DrChrono account, hover over the 'Account' tab on the top panel, and from the drop-down menu, click on the 'Offices' button.
Now, you will see a list of all the active offices associated with your DrChrono account. To locate the office ID for any office, click on the 'Edit' button next to the name of the office.
After you click on the 'Edit' button, an office ID will appear in the address bar. In this case, the office ID for DrChrono will be '26631'.
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 an 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 Drchrono 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.
Appointment Status: You can customize the appointment status property by entering multiple comma-separated values.
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: The Office ID is used to keep the providers in it. We have multiple providers in the same Office ID and may have a specific Office ID for each provider.
Please refer to this link for the steps to find DrChrono's doctor ID, practice group ID, and office ID.Status: It shows the integration status (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.
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.
Completing the Integration Process
After the initial integration is set up by the Birdeye technical support team, you need to log in to your Birdeye account to complete the rest of the integration process.
To complete the process, 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 DrChrono website. Enter the username and password associated with your DrChrono account and click on the 'Log In' button.
Once you have signed in to your DrChrono account, Birdeye will ask for certain permissions to obtain patient data from your DrChrono account. Click on the 'Authorize' button at the bottom to complete the integration process.
After the access has been granted, you will be redirected to the Birdeye dashboard, and an ‘Authorized' message will appear right next to DrChrono. Once you are disconnected, you will no longer be able to fetch customer information from DrChrono CRM. The 'Disconnect DrChrono' button will change to 'Connect to DrChrono.’
Curl Commands
Before you can integrate DrChrono 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 this 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": 152242293786525, "integrationSourceId": 8,
"integrationGroupTriggers":[{"triggerId":8,"triggerTypeId":1}] ,"integrationGroupProperties": [{ "propertyKey": "appointment_status", "propertyValue": "Complete", "isSecure": false } ] }'152242293786525 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
8 - 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 DrChrono. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Complete - Appointment Status - You can customize the "appointment_status" property by entering multiple comma-separated values.
Fetch information for all the triggers available for DrChrono (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/8 -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": 8,
"integrationSourceId": 8,
"triggerService": "drchronoAppointmentTriggerService",
"displayName": "Dr Chrono Appointments Trigger",
"description": "This trigger is used to fetch customer data based on the completed appointments",
"active": true,
"integrationSourceName": "drchrono",
"integrationTriggerType":[{"id":1,"name":"JOB"}]
}
]8 - Trigger ID
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/152242293786525 -H 'Cache-Control: no-cache'
Sample Response:
[
{
"groupId": 38,
"integrationSourceType": {
"id": 8,
"integrationSource": "DRCHRONO",
"sourceCategory": "Healthcare",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 8,
"triggerTypeId": 1
}
]
}
]152242293786525 - Business ID: Enter the Business ID here to get the integration group details for a business.
38 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
Update triggers in Integration Group (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": 38,"integrationGroupTriggers":[{"triggerId":10,"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.
38 - The Group ID which was returned in the previous step will be entered here.
10 - 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":152242293786525,"integrationGroupId":38,"active":true,"officeId":"81406"}'81406 - Office ID: The Office ID will be shared by the DrChrono client during the initial setup.
38 - 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 Drchrono are:
Appointment status is not in the allowed list
Integration is beta
Description
The patient appointment status is different than those present in the allowed list of status.
The integration setup is currently set to beta.


























