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 Clio
User Manual - SUPPORT ARTICLE
Clio is a Practice Management Software (PMS) used by law firms and lawyers to automate administrative and operational aspects of their businesses. Clio helps its clients to manage cases, clients, documents, bills, calendars, time tracking, reporting, and accounting. Integrating Clio with Birdeye will automate the process of sending out review requests to clients on a daily basis.
Once Clio is integrated with Birdeye, Birdeye will pull client information from Clio once daily from the cases that 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
Integration Process
Login
Manage Triggers
Manage Properties
Manage Locations
How to create ‘Custom Fields’ on Clio Account:
How to create ‘Don’t Send Review’ Custom Field? (Applicable for any trigger)
How to create a ‘Location’ Custom Field? (Applicable for any trigger)
Dashboard Setup
Setup Through Birdeye Dashboard
Enabling ‘Send Review’ Button
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 Clio:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Clio Closed Matter Trigger | Closed Matter | This trigger is used to fetch customer data based on closed matters. |
Clio Pending Matter Trigger | Pending Matter | This trigger is used to fetch customer data based on pending matters. |
Clio Open Matter Trigger | Open Matter | This trigger is used to fetch customer data based on open matters. |
Birdeye also allows businesses to send review requests manually. Here is the supported trigger for Clio.
Trigger name | Trigger Name/ Value | Trigger description |
Clio Matter Webhook Trigger | Matter |
This trigger is used to fetch customer data based on matter ID.
NOTE: This trigger must be used to enable the Clio custom button.
|
Details required from the Clio dashboard
Trigger Details
Details required from the Birdeye dashboard
Location Name
Business ID in case of an SMB Business
Enterprise ID in case of a Multi-location Business
Authorization from Birdeye dashboard
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 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.
Integration Process
Before you can integrate Clio 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
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 for all locations under a CRM.
Don’t send review custom field name: It is used where businesses do not want to send review requests. Upon creation, it will be a checkbox option under Matters.
Location Custom Field: This is the field name for the location.
Note: In case of adding a custom field name using curl command, use this command.
For Single Location accounts, the ‘Location Custom Field’ name will be blank and only ‘Don’t Send Review’ custom field name will be added.
For Multi Location accounts, the ‘Location Custom Field’ name will also be added.
For Webhook Trigger only, you can set ‘Customer Fetch Delay’ if the client has requested to set a delay (Number of days) and click Next (It can be left as blank if the client wants to send 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 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.
Location Name (Webhook Trigger): Enter the location name (same as the one used in Clio). Location Name needs to be added for Multi-location or Enterprise shell accounts.
Customer fetch delay (For webhook trigger only): It is used if businesses want to send review requests with a delay (number of days).
Location Name: Enter the location name (same as the one used in Clio). Location Name needs to be added for Multi-location or Enterprise shell accounts.
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: You can use ‘manage the locations’ using this curl command.
For Enterprise: You can use ‘manage the locations’ using this curl command.
For Webhook Point: 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 Clio website. Enter the email address and password associated with your Clio account and Click on ‘Sign in.’
Once you have signed in to your Clio account, Birdeye will ask for certain permissions to obtain client data from your Clio account. Click on the ‘Allow Access’ 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 Clio.
Review requests will be sent to your customers by default. To not send review requests for selected matters, you need to create a 'Custom Field' within your Clio account.
How to create ‘Custom Fields’ on Clio Account:
To create a 'Custom Field', login to your Clio account and click on the 'Settings' tab from the left navigation rail. Once on the 'Settings' page, click on 'Custom Fields' under the 'System' header. If you need help setting up the custom field, reach out to the Birdeye technical support team.
To create a new custom field, click on the 'Add' button on the top right corner.
How to create ‘Don’t Send Review’ Custom Field? (Applicable for any trigger)
After you click on the 'Add' button, a pop-up will open up where you have the capability to give a name and add a type to your custom field. Enter 'Don't Send Review' in the name field, and select 'Checkbox' in the type field. Also, check the 'Default' checkbox and click on the 'Save' button to create a new custom field.
How to create a ‘Location’ Custom Field? (Applicable for any trigger)
In case of a multi-location account, you will need a custom field for managing your locations which should be of type 'Picklist'. If you are already using a location custom field, provide the name of that custom field to the Birdeye support team. If you don't use a location custom field, you will need to create an additional custom field labeled as 'Location'. Once you have entered 'Location' in the name field, select the 'Type' as 'Picklist' and check the 'Default' and ‘Required' boxes.
Now, use the 'Plus' sign to add different locations to the custom field. Once you have entered the name of all the locations associated with your Birdeye account, click on the 'Save' button.
Note: You can check the group details using this curl command.
After you have created the 'Custom Field', it will appear under the 'Individual Fields' column. To verify if the custom field has been created successfully, click on the 'Create New' tab on the top right corner and from the drop-down menu select 'Matter'.
For multi-location businesses, the 'Location' custom field will appear next to the 'Don't Send Review' custom field.
Once you are in the process of creating a new matter, a 'Don't Send Review' checkbox will appear on the bottom. If you do not want to send a review request to the customer, check the 'Don't Send Review' box. By default, if the checkbox is not checked, review requests will be sent out to your clients for all closed matters.
For multi-location businesses, select a location from the drop-down menu while creating a matter.
Once the integration is complete, Birdeye will send out review requests to the client related to the closed matter for which the 'Don't Send Review' checkbox has not been checked.
IMPORTANT:
As a best practice, while entering the ‘Location names’, make sure that you do not add <SPACE> before/after the ‘Location name’. Adding a <SPACE> creates duplicate entries for the ‘Location name’.
If you want to delete a ‘Custom field’, make sure that you resolve the matters the custom field is mapped with.
Clio users with a ‘Starter’ subscription plan will not be able to view custom fields as ‘Location’ or ‘Don’t Send Review’, as the starter plan has limited features.
To learn more about the different subscription plans offered by Clio, click here.
Once the custom fields are created in Clio CRM, the customer needs to authorise Clio from the Birdeye dashboard:
Enabling 'Send 'Review' button to send review requests manually
To enable the 'Send Review' button on your Clio account, you have to integrate with the 'Webhook' trigger. After the integration is complete, you need to authorize the business using your Clio account. When you log in to your Clio account which was used for authorization, you will be able to view the 'Send Review' button.
In case you want to stop or discontinue the integration with Clio, you can do so using the 'Disconnect Clio' button inside the 'Setup' tab. Once clicked, your Clio account will be disconnected from Birdeye and the 'Disconnect Clio' button on this page will revert back to 'Authorize Clio'. You can authorize the integration anytime again, as done in step two above.
NOTE: After the above integration is successfully implemented, you no longer need to manually check-in your clients in case you were doing so earlier. If the Birdeye team was doing it for you, reach out to the technical support team and notify them about the integration with Clio.
Curl Commands
Before you can integrate Clio 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 for SMB Business (Curl Command)
Copy this Curl Command
curl -X PUThttps://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "parentBusinessNumber" :149451644517222, "integrationSourceId" : 2, "integrationGroupTriggers":[{"triggerId":16,"triggerTypeId":2}]}'149451644517222 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
2 - 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 Clio. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Add new custom field name (Curl Command)
Copy this Curl Command
curl -X PUThttps://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d
'{"parentBusinessNumber" :151544645328379,"integrationSourceId" : 2, "integrationGroupTriggers":[{"triggerId":2,"triggerTypeId":1}],"integrationGroupProperties" :[{"propertyKey" :"dont.send.review.field.name","propertyValue" :"No review requests"}]}'151544645328379 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
2 - 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 Clio. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
"No review requests" - send.review.field.name - Insert the "dont.send.review.field.name" custom field property if the customer is using any other name apart from ‘Don’t send review’ for the custom field.
Create Integration Group for Enterprise Business (Curl Command)
Copy this Curl Command
curl -X PUThttps://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "parentBusinessNumber" :149451644517222, "integrationSourceId" : 2, "integrationGroupTriggers":[{"triggerId":2,"triggerTypeId":1}],"integrationGroupProperties" :[{ "propertyKey" :"clio.location.custom.field.name", "propertyValue" : "New Location" } ] }'149451644517222 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
2 - 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 Clio. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
New Location - location.custom.field.name: Insert the "clio.location.custom.field.name" custom field property in the curl command only if the value of the location custom field is not ‘Location’.
Fetch information for all the triggers available for Clio (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/2 -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": 2,
"triggerService": "clioClosedMatterTriggerService",
"displayName": "Clio Closed Matter Trigger",
"description": "This trigger is used to fetch all closed matters from Clio based upon the date specified",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1
},
{
"id": 81,
"triggerService": "clioMatterWebhookTriggerService",
"displayName": "Clio Matter Webhook Trigger",
"description": "This trigger is used to fetch customer data based on matter id.",
"active": true,
"integrationTriggerType": {
"id": 2,
"name": "WEBHOOK"
},
"caseCreationTriggerType": {
"id": 2,
"name": "WEBHOOK"
},
"actionGroupId": 1
},
{
"id": 22,
"triggerService": "clioPendingMatterTriggerService",
"displayName": "Clio Pending Matter Trigger",
"description": "This trigger is used to fetch all pending matters from Clio based upon the date specified",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1
}
]2, 22,81 - Trigger IDs
Find 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.
[
{
"groupId":3,
"integrationSourceType":{
"id":2,
"integrationSource":"CLIO",
"sourceCategory":"Legal",
"oauthEnabled":true
},
"integrationGroupTriggers": [
{
"triggerId": 2,
"triggerTypeId": 1
}
]
}]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 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 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 Location Mapping
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 -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "businessNumber": 149451644517222, "integrationGroupId" : 11, "active": true }'149451644517222 - Business ID: Enter the Business ID for the SMB Business.
11 - 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 -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "businessNumber": 149451644517222, "integrationGroupId" : 11, "active": true,"integrationProperties":[ { "propertyKey" :"clio.location.name", "propertyValue" :"Norman" } ] }'149451644517222 - Business ID: Enter the Business ID for the SMB Business.
11 - Group ID: Enter the Group ID which was returned when the Integration group was created.
true - Active: Enter true for enabling the integration.
Norman - Location Name: Enter the Location name as per the name specified in the Clio account for Location picklist corresponding to this business
Webhook 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": 149451644517222, "integrationGroupId" : 11, "active": true,"integrationProperties":[ { "propertyKey" :"clio.webhook.location.name", "propertyValue" :"Norman" } ] }'149451644517222 - Business ID: Enter the Business ID for the SMB Business.
11 - Group ID: Enter the Group ID which was returned when the Integration group was created.
true - Active: Enter true for enabling the integration.
Norman - Location Name: [webhook.location.name] Enter the Location name as per the name specified in the Clio 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 Clio are:
Matters don't send review request custom field value is true
Integration is beta
{"error":{"type":"AccessDenied","message":"You don't have permission to view custom fields."}}
Business has not been Authorized, please move to Birdeye dashboard to authorise the business.
Either of Phone or Email should be valid for the creation of customer Email:null Phone :null
Description
Review Request is sent only for those clio clients that have custom field value for Don't Send Review .
The integration setup is currently set to beta.
User does not have permissions to view the custom fields. In Clio CRM, please goto Settings ->Manage users -> Click on Edit for the user you wish to update the permissions -> Select the permission and Click on Save New Information.
Please Login to the Birdeye dashboard to Authorise the business.
Either the phone number or the email address needs to be added correctly.