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 Denticon
User Manual - SUPPORT ARTICLE
Denticon by Planet DDS is a cloud-based Practice Management System (PMS) for dental professionals. The PMS supports various features including patient account management, patient records management, appointment management, billing. etc. Denticon supports multi-location dental practices, medium-sized practices, and solo practices.
Birdeye can seamlessly integrate with your Denticon account and send out review solicitations to your customers automatically. Integrating Denticon with Birdeye will automate the process of sending out review requests to patients on a daily basis.
Table of Contents
Triggers Supported
Details required from Denticon dashboard
Information from Birdeye dashboard
Mandatory Authorization
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers supported
Birdeye allow you to fetch data from your CRM using a predefined trigger. Here is the supported trigger for Denticon:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Denticon Appointment Trigger | Appointment | This trigger is used to fetch customer data based on the completed appointments. |
Details required from Denticon dashboard
Denticon API Key
Denticon Practice Group ID
Denticon Office IDs for all offices
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.’
The ‘Business ID’ and ‘API key’ are shown in the image.
For multi-location accounts -Business ID and API Key
Enterprise 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.’
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.
Locate Denticon API
Navigate to planetdds.com and log in to your Denticon account using your login credentials.
After you have logged into your Denticon account, click on the 'Help' tab on the top panel, and from the drop-down menu click on the 'Help & Support' button.
Once on the 'Help & Support' page, click on the 'Generate Client Key' button on the bottom.
The API Client Key for your Denticon account will now be available under the 'API Client Key' header.
Locate the Denticon Practice Group ID and Office IDs
Each Denticon account has a unique Practice Group ID (PGID) and multiple Office IDs (OIDs) corresponding to the business locations. To find OID for a Denticon Office ID, log in to your Denticon account and select a Denticon Office from the top panel. The OID for the selected office will be available in the top right corner with the unique PGID.
Initial Authorization
Birdeye will need authorization from Denticon to access their practice data. This is a mandatory step before integration can be set up. In order to allow access, you need to follow the below steps:
Step 1: Log in to Denticon https://denticon.com/.
Step 2: Go to the ‘Setup.’ Click on ‘Offices’ and select ‘Vendor API Settings.’
Step 3: On the left-hand side of the screen, you will view the list of vendors that are assigned to this PGID.
Step 4: Click on Birdeye to see which OIDs Birdeye currently has access to.
Step 5: To give the Birdeye access to selected or all OIDs, select Birdeye and click ‘Edit.’
Step 6: To grant OID access to Birdeye, move the OID from the available column to the assigned column and click ‘Save.’
Integration Process
Before you can integrate Denticon 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 Planet DDS (Denticon) 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.
Practice group ID: Please enter the practice group id provided by the customer.
Appointment status: Enter the appointment status for which the business wants to send the review requests. Comma separated values can be added.
Api auth key: Please enter the Denticon api auth key provided by the customer.
Customer Fetch Delay: 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.
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 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 changes, if required.
Officeid: Enter the Office id provided by the customer.
Status: It shows the integration status (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 integration will run.
Customer Fetch Delay: It is used if businesses want to send review requests with a delay (in days).
Denticon Office Id: Enter the Office id provided by the customer.
Override Group Properties: With this, you can override the Practice group ID, Api auth key, Appointment status and Customer Fetch Delay property added at the location level.
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 Denticon 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" :151980725935863, "integrationSourceId" : 11,"integrationGroupTriggers":[{"triggerId":11,"triggerTypeId":1}], "integrationGroupProperties" :[ { "propertyKey" :"denticon.api.auth.key", "propertyValue" :"AAC6DB7A-5A66-4EBC-B694-D6BCD99881CB", "isSecure" : true }, { "propertyKey" :"denticon.practice.group.id", "propertyValue" : 1 }] }'151980725935863 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
11 - 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 Denticon. Identify the trigger ID (s) and insert (use commas) in case of multiple trigger IDs.
AAC6DB7A-5A66-4EBC-B694-D6BCD99881CB - denticon.api.auth.key - Enter the value as given by the customer.
1 - denticon.practice.group.id - Enter the value as given by the customer.
Fetch information for all the triggers available for Denticon (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/11 -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 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.
[{"id":11,"integrationSourceId":11,"triggerService":"denticonAppointmentTriggerService","displayName":"Denticon Appointment Trigger","description":"This trigger is used to fetch customer data based on the completed appointments","active":true,"integrationSourceName":"Denticon","integrationTriggerType":[{"id":1,"name":"JOB"}]}]11 - Trigger ID
Update Triggers Information (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": 14,"integrationGroupTriggers":[{"triggerId":11,"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
14 - The Group ID that was returned in the previous step will be entered here.
11 - Enter the Trigger ID(s) that need to be added or updated to the integration.
Curl Command to find Business Integration Group Details
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/149218774826029 -H 'Cache-Control: no-cache'
149218774826029 - Business ID: Enter the Business ID here to get the integration group details for a business.
Sample Response:
[{"groupId":49,"integrationSourceType":{"id":11,"integrationSource":"DENTICON","sourceCategory":"Dental","oauthEnabled":false},"integrationGroupTriggers": [{"triggerId": 11,"triggerTypeId": 1}]}]49 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
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 'cache-control: no-cache' -H 'content-type: application/json' -d '{"businessNumber":151980725935863,"integrationGroupId":13,"active":true,"officeId":"101"} '151980725935863 - Business ID: Enter the Business number here
13 - Integration Group ID: Enter the Integration Group ID which was returned when the Integration group was created.
101 - Denticon Office ID: A unique ID that corresponds to a business location within Birdeye. The Office ID for each Birdeye location will be shared by the customer during the initial setup.
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 as given in the below document.
Campaigns Tags
Campaign tags are used to set up campaigns within the Birdeye dashboard. These tags are either provided by the client or can be fetched from Kibana for already checked contacts.
Denticon Campaign tags are:
pms_appointment_status
Restriction Reason
Restriction reason is used to identify the contacts which 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 Denticon are:
Appointment status is not in the allowed list
Integration is beta