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 Dentrix Ascend
User Manual - SUPPORT ARTICLE
Dentrix Ascend is a web-based Practice Management Software (PMS) that offers front office, clinical and business tools for dental practices. Integrating Dentrix Ascend with Birdeye will automate the process of sending out review requests to customers on a daily basis.
Once Birdeye is integrated with Dentrix Ascend, Birdeye will pull data pertaining to patients who visited the practice 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
Details required from Denticon dashboard
Information from Birdeye dashboard
Mandatory Authorization
Dentrix Ascend Initial Platform Setup
Business Integration Group
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers supported
Birdeye allows you to fetch data from your CRM using some predefined triggers. As part of the integration process, you will need to ask the business for its preference. After integration is complete, requests will be sent out based on the configured trigger. Here is the supported trigger for Dentrix Ascend:
Trigger Display Name | Trigger Name/ AdditionalParam Value | Trigger Description |
DentrixAscend Trigger Service | Appointment | This trigger is used to fetch patient data from DentrixAscend. |
Details required from the Dentrix Ascend dashboard
Dentrix Ascend Username and password
Account ID
Location name
Dentrix Ascend URL
Details required from the Birdeye dashboard
Enterprise ID for 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 account - 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.
Dashboard Setup
Dentrix Ascend Initial Platform Setup [IMPORTANT]
To check if the Birdeye report format has been created for the Dentrix client, log in to Dentrix Ascend platform using the client credentials. Navigate to https://live.dentrixascend.com and enter the Organization ID, Username and Password for the Dentrix client.
NOTE: The Dentrix credentials will be provided by the client during the initial call.
Navigate to home: Once you have logged in, click on the ‘Inverted arrow’ option next to the ‘Home’ button.
Go to ‘Power Reporting’: Now, click on the ‘Power Reporting’ button placed under the ‘Reports’ icon.
View existing reports or create one: If you find a report named as ‘Birdeye’ under ‘My Reports’, double-click to view the report.
NOTE: If you don’t see any report under the ‘My Reports’ header, you will need to create a new report with the accepted format.
Format to create a report: The report should always be in the following format: Last visit> First Name> Last Name> Email> Phone for the integration to successfully work with Birdeye.
Create a new report: To create a new report, click on the ‘Interactive Patient Report Builder’ button on the bottom of the ‘Power Reporting’ page.
NOTE: This is not required if the report already exists for the business.
Create a new report format: On the new page, you have the ability to create a new report in a customized format by clicking on the ‘Toggle View’ button. To create a new report format, drag and drop the five required fields (Last Visit, First Name, Last Name, Email and Phone) to the report builder.
Add a Date filter: Once you have added the five required fields, it is also essential to create a date filter for Birdeye to accurately fetch patient data for the previous day. To create a date filter, right-click on the ‘Last Visit’ field and from the drop-down menu click on the ‘Filter’ button.
Select the Present date: Once the pop-up opens up, select the present date and click on the ‘OK’ button.
Save the report: After you have created the new customized report with the date filter settings in a format suitable for the Birdeye integration, click on the ‘Save’ button on the top right corner.
Save the report: Upon clicking the ‘Save’ button, the system will prompt you to give a name to the report. Name the new customized report as ‘Birdeye’ and click on the ‘OK’ button.
NOTE: Always ensure the report is saved under ‘My Reports’.
For Enterprise customers the following steps need to be followed:
Find the location name from Dentrix Ascend account
Create a location filter and set the location name
Save the report again
Find the Location Name: Once on the Dentrix Ascend dashboard, click on the ‘Settings’ tab and from the drop-down menu click on the ‘Location Information’ option.
Switch Between Locations: On this page, you can copy the location name to the clipboard. To switch between locations, click on the location selection icon next to the ‘Settings’ tab. This location name will be used in location filter during report generation.
Create a Location Filter: In addition to the required steps for SMB businesses, you also need to create a location filter for Birdeye enterprise customers. To create a location filter, right-click on the ‘Location’ field and from the drop-down menu click on the ‘Filter’ button.
Name the Location to set integration: Now, select the second option ‘Specify a condition’.
Enter the name of the location(any one location in case of multi-location) for which you want to set-up the integration, and click on the ‘OK’ button.
For both single location or multi-location setup you can provide at least one location name here in the location filter. The value of the filter will be updated whenever we run the integration. Here the presence of location filter is important, not its value, so you can provide any of the location name even if you are setting up multi-location.
Save Report Again:
Exception in case the of SMB account
In case of more than one location on UI (for SMB business), pass the location name along with account ID in the query. This is similar to the case of an enterprise business query. The valid format is AccountId:LocationName which is to be entered on the Integration Dashboard.
Integration Process
Before you can integrate Dentrix Ascend with Birdeye, you will need to set up the following configurations on the integrations 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 for all locations under a CRM.
Customer Fetch Delay: It is used if businesses want to send review requests with a delay (number of days). You can set a delay or leave it blank 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 drop down and click on ‘Add.’
(In 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 changes if required.
Status: It shows the status of 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.
Username: Enter the username provided by the customer.
Password: Enter the password provided by the customer.
Account ID: Enter the Account ID provided by the customer.
Domain URL: Customer will provide the Dentrix Ascend domain URL, which they use for logging into the CRM.
NOTE:
For Multi-locations, pass the Location Name after the AccountID provided by the client such as 104323:Espire. The valid format is Accountid:LocationName. Remember to provide the colon(:) as a separator. This format is supported when,
You are setting up a multi-location business so there would be more than one location in client’s Dentrix Ascend.
If you are setting up a SMB account and the client’s Dentrix Ascend has more than one location and we only want to fetch customers of one Dentrix Ascend location.
Override Group Properties: With this, you can override the Customer Fetch Delay property added at group level, specific to each location.
Click on ‘Next’ and click on ‘Save.’
Note: For SMB and Enterprise you can use ‘manage the locations’ using this curl command.
Curl Commands
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.
Before you can integrate Dentrix Ascend with Birdeye, you will need to set up the following configurations:
Create an Integration Group (Curl Command)
Copy this Curl Command
curl -X PUThttps://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'content-type: application/json' -d '{ "parentBusinessNumber": 153142308913411,"integrationSourceId": 38, "integrationGroupProperties": [ ],"integrationGroupTriggers":[{"triggerId":60, "triggerTypeId":1}]}'153142308913411 - Business ID: This is the business Id for the location, both in the case of SMB and Enterprise account.
60 - Integration Trigger ID: Can be one or more triggers. Ask client what trigger they would like to integrate with then run the curl command to fetch all possible triggers for Dentrix Ascend. Identify the trigger Id(s) and insert (use commas) in case of multiple trigger Ids.
Find Business Integration Group Details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/153142308913411 -H 'Cache-Control: no-cache'
153142308913411 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
[
{
"groupId": 1670,
"integrationSourceType": {
"id": 38,
"integrationSource": "DENTRIXASCEND",
"sourceCategory": "Dental",
"integrationType": "Birdeye API",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 60,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
}
]1670 - Group ID: A group Id will be returned in the sample response with the details of the existing triggers for a business.
Fetch information for all the triggers available for Dentrix Ascend (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/38 -H 'cache-control: no-cache' -H 'content-type: application/json'
[
{
"id": 60,
"triggerService": "dentrixAscendTriggerService",
"displayName": "DentrixAscend Trigger Service",
"description": "This trigger is used to fetch patient data from DentrixAscend.",
"active": true,
"integrationTriggerType": [
{
"id": 1,
"name": "JOB"
}
],
"actionGroupId": 1
}
]60 - Trigger ID
Sample response: A sample response like this would appear after you run the curl command. The response will have the trigger name, description and the ID. This trigger Id will be utilized while creating the integration group. An integration can have one or more triggers. To use more than one trigger, enter comma separated values while creating the integration group.
Update Triggers Information- Only required if 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": 1670,"integrationGroupTriggers":[{"triggerId":60,"triggerTypeId":1}]}'replaceTriggers=true - To replace existing trigger(s), enter the value for replaceTriggers as To add new trigger(s) to the existing list, the value for replaceTriggers should be false
1670 - The Group ID that was returned in the previous step will be entered here.
60 - 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 this Curl Command
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'content-type: application/json' -d '{ "businessNumber": 153142308913411,"integrationGroupId": 1670, "active": true, "integrationProperties": [{"propertyKey" : "da.username","propertyValue": "lakisha","isSecure":false},{
"propertyKey" : "da.password","propertyValue": "Fall2018**_","isSecure":false},{
"propertyKey" : "da.business_id","propertyValue": "mayfam","isSecure":false},{
"propertyKey" : "da.domail_url","propertyValue": "https://live3.dentrixascend.com","isSecure":false}
]}'153142308913411 - Business Number: Enter the Business number here
1670 - Integration Group ID: Enter the Integration Group ID which was returned when the Integration group was created.
lakisha - Username: The Username will be shared by the customer in the initial setup call.
Fall2018 - Password: The Password will be shared by the customer in the initial setup call.
mayfam - Account ID: The Account Id (Organization ID in Dentrix Ascend) will be shared by the customer in the initial setup call.
https://live3.dentrixascend.com - Domain URL: The ‘login url’ will be shared by the customer in the initial setup call. The correct url will be along with https:// , for eg. https://<live><number>.dentrixascend.com and without anything after the domain name.
Note: To integrate SMB business where data has to be pulled from multiple locations (not all locations, as in case of all locations, location filter is not required) from dentrix Ascend, we need to follow below steps:Add all location names in Birdeye report while creating Location Filter.
Keep accountId as a location property, such as Mayfam
Possible Error And Resolution at Support End
{"data":[],"error":{"code":101,"message":"Error in Dentrix Ascend - [username/businessId]:[Birdeye/84711] - Report Page Error - "}}
This indicates that the Birdeye report has not been created on Client’s Dentrix Ascend Platform.
{"data":[],"error":{"code":101,"message":"Error in Dentrix Ascend - [username/businessId]:[Birdeye/89867] - Location not defined - "}}
This indicates that the Birdeye report doesn’t have a Location filter and we have provided it on Integration Dashboard.
{"data":[],"error":{"code":101,"message":"Error in Dentrix Ascend - [username/businessId]:[Jordan/14825] - Filter click - Cannot read property 'contentWindow' of null"}}
Filter click - Cannot read property: This indicates that the Birdeye report has no Last Visit Filter on Client’s Dentrix Ascend Platform
{"data":[],"error":{"code":101,"message":"Error in Dentrix Ascend - [username/businessId]:[Jordan/NSDP] - Authentication Issue - "}}
Authentication Failed: Credentials are Incorrect, update with the correct credentials.
{"checkinDetails":[],"errorCode":"404","exceptionMessage":"No data found!"}
This error doesn’t signify that integration is not running, the integration setup is correct and there were no patients on that particular date. If you need more info, you can go to Reports on Dentrix Ascend and check for that date.
Socket closed
This means that the earlier test run took much time so you need to retry again by clicking on the “SAVE” button in Integration Dashboard, this will retry the validation test and mark validated = true.
{"checkinDetails":null,"errorCode":null,"exceptionMessage":null}
Connect with Integration them if you see this error.