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 Redox
User Manual - SUPPORT ARTICLE
Redox is an EHR integration and healthcare platform that accelerates the development and distribution of healthcare software solutions. Redox is the market-leading provider of EHR integration in the US. It supports real-time exchange between 300+ independent software vendors and 1700+ healthcare delivery organizations, across 85+ EHRs and HIEs, including Epic, Cerner, Allscripts, and Athenahealth. Healthcare verticals use Redox for their EHR integration needs, including telehealth, remote patient monitoring, revenue cycle management, appointment scheduling, and care coordination.
Once Redox is integrated with Birdeye, Birdeye will get client information as webhook requests from Redox once the cases were closed on the previous day. 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
Information required from the Business
Trigger details
Location name
Business ID for single-location business
Login
Manage Triggers
Manage Properties
Manage Locations
Restriction Reason
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 Redox:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Redox Patient Admin Trigger | PatientAdmin Trigger | This trigger is used to fetch customer data based on the patient admin data. |
Redox Scheduling Trigger | Scheduling Trigger | This trigger is used to fetch the customer data received from redox-based on the appointment status configured. |
Details required from the Redox dashboard
Trigger Details
Source ID
Details required from the Birdeye dashboard
Location Name
Business ID in case of an SMB Business
Business ID in case of a Multi-location Business
Information from Birdeye Dashboard
For a 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 Redox 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.
Source ID: Enter the source ID from the Redox engine dashboard for each trigger. Please refer to the section How to fetch source ID.
Redox Location Filter:Its value indicates which value will serve as the location filter. There are two values:
Department based- We will match the department provided against an appointment.
Provider-based - We will match with the attending provider against an appointment.
Appointment Status: Applicable for scheduling trigger. Enter the allowed appointment status in a comma-separated list for the scheduling trigger clients want to send review requests.
PMS Name: Enter the PMS name for which Redox is fetching data.
Review request delay: You can set a review request delay if the client has requested to set a delay (Number of days).
NOTE: It can be left blank if the client wants to send a review request immediately.
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 you only one option).
A drawer will appear on the right-hand side.
The Status will be set by default. You can make changes if required.
Status: It shows integration status (Active or Inactive).
Review request delay: You can set a review request delay if the client has requested to set a delay (Number of days).
NOTE: It can be left blank if the client wants to send a review request immediately.Location: For Multi-Location accounts, select the Redox location filter based on which location will be segregated.
Override Group Properties: With this, you can override the properties added at the group level, specific to each location.
Click on ‘Next’ and click on ‘Save.’
Before setting up the integration on the dashboard, you need to set up the subscription on the Redox engine.
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.
Fetch Source Dashboard Setup
To fetch the Source ID, follow the steps below:
Click on the ‘Connections’ button.
Click on ‘ID.’
You can copy the ID by clicking on the ‘Copy ID.’
Add in the Integration dashboard.
Curl Commands
Before you can integrate Redox 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 common properties 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 you will need to run to set this up.
Create Integration Group for SMB Business (Curl Command)
Copy this Curl Command
curl-X PUT'https://common-services.birdeye.com/integration/add/businessintegrationgroup' \--header 'Content-Type: application/json' \--data-raw '{"parentBusinessNumber": 164181194891424,"integrationSourceId": 110,"integrationGroupProperties": [{"propertyKey": "redox.source.id","propertyValue": "cd79e103-c70e-4a3b-ab37-bb5d59097c6d","isSecure": false},{"propertyKey": "redox.visit.status","propertyValue": "completed","isSecure": false}{"propertyKey": "pms.name","propertyValue": "epic","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 120,"triggerTypeId": 2,"actionIds": [1]}]}'164181194891424-Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account.
120- Integration Trigger ID - This can be one or more triggers. Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for Redox. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Create Integration Group for Enterprise Business (Curl Command)
Copy this Curl Command
curl -X PUT'https://common-services.birdeye.com/integration/add/businessintegrationgroup' \--header 'Content-Type: application/json' \--data-raw '{"parentBusinessNumber": 164181194891424,"integrationSourceId": 162,"integrationGroupProperties": [{"propertyKey": "redox.source.id","propertyValue": "cd79e103-c70e-4a3b-ab37-bb5d59097c6d","isSecure": false},{"propertyKey": "redox.visit.status","propertyValue": "completed","isSecure": false},{"propertyKey": "redox.location.identifier.key","propertyValue": "Department","isSecure": false},{"propertyKey": "pms.name","propertyValue": "epic","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 120,"triggerTypeId": 2,"actionIds": [1]}]}'164181194891424- Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
162- Integration Trigger ID - Can be one or more triggers. Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for Redox. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
New Location - location.custom.field.name: Insert the "redox.location.custom.field.name" custom field property in the curl command only if the value of the location custom field is not ‘Location’.
Visit Status - visit.status - Enter comma separate list of visit status for which client want to send review request for scheduling trigger of redox
Fetch information for all the triggers available for Redox (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/110 -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": 120,"triggerService": "redoxSchedulingWebhookTriggerService","displayName": "Redox Scheduling Trigger","description": "This trigger is used to fetch the customer data received from redox based on the appointment status configured.","active": true,"integrationTriggerType": {"id": 2,"name": "WEBHOOK"},"actionGroupId": 1,"sourceIdsList": [110],"triggerName": "Scheduling Trigger"},{"id": 119,"triggerService": "redoxPatientAdminWebhookTriggerService","displayName": "Redox Patient Admin Trigger","description": "This trigger is used to fetch customer data based on the patient admin data.","active": true,"integrationTriggerType": {"id": 2,"name": "WEBHOOK"},"actionGroupId": 1,"sourceIdsList": [[110],"triggerName": "PatientAdmin Trigger"}]119,120 - Trigger IDsFind business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/149451644517222 -H 'Cache-Control: no-cache'
149451644517222- Business ID: Enter the Business ID here to get the integration group details for a business.
Sample:
[{"groupId":3,"integrationSourceType":{"id":2,"integrationSource":"REDOX","sourceCategory":"Healthcare","oauthEnabled":false},"integrationGroupTriggers": [{"triggerId": 120,"triggerTypeId": 2}]}]3- 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 a 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": 14,"integrationGroupTriggers":[{"triggerId":2,"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.
14- Group ID: The Group ID which was returned in the previous step will be entered here.
2-Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Mapping (SMB Businesses)
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' \--header 'Content-Type: application/json' \--data-raw '{"businessNumber": 164181194891424,"integrationGroupId" : 839,"integrationProperties":[],"active": true,"test": true,"beta":false}'164181194891424-Business ID: Enter the Business ID for the SMB Business.
839-Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true for enabling the integration.
Integration Mapping (Enterprise Businesses):
Copy this Curl Command
curl -X PUT'https://common-services.birdeye.com/integration/add/businessintegrationmapping' \--header 'Content-Type: application/json' \--data-raw '{"businessNumber": 164181194891424,"integrationGroupId" : 839,"integrationProperties":[{"propertyKey": "redox.location","propertyValue": "NYPQLABOTRCH","isSecure": false}],"active": true,"test": true,"beta":false}'164181194891424-Business ID: Enter the Business ID for the SMB Business.
839- Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true for enabling the integration.
NYPQLABOTRCH-Location Name: Enter the Location name as per the name specified in the Redox account for Location picklist corresponding to this business
Appendix
Restriction Reason and exceptions
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. Also, the exceptions can be seen on the integration dashboard or Kibana error logs.
Possible restriction reasons or exceptions for Redox are:
The appointment status is not on the allowed list.
Integration is beta.
The visit date doesn't match with today's date.
The patient’s discharge date doesn't match with today's date.
Description
Review Request is sent only for those Redox PMS clients that have appointment status, which is not in the allowed list for scheduling trigger.
The integration setup is currently set to beta.
The visit date doesn't match with today's date for the scheduling trigger.
The discharge date doesn't match with today's date for the patient admin trigger.