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 PracticePanther
User Manual - SUPPORT ARTICLE
PracticePanther is a cloud-based legal practice management software (PMS) used by law practitioners. The PMS has many features, including document management, billing, tracking, reporting etc.
Once PracticePanther is integrated with Birdeye, Birdeye will pull client information from PracticePanther once daily from the matters 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
Triggers Supported
PracticePanther Organization ID
Enterprise ID for multi-location accounts and Business ID for all locations
Business ID in case of a single-location account
Login
Manage Triggers
Manage Properties
Manage Locations
For Single Location Accounts
For Enterprise Businesses
Integration Requirements
Triggers supported
Birdeye allow you to fetch data from your CRM using some predefined triggers. Here is the supported trigger PracticePanther:
Trigger Display Name | Trigger Name/Value | Trigger Description |
PracticePanther Closed Matter Trigger | Matter | This trigger is used to fetch customer data based on closed matters. |
Details required from the PracticePanther dashboard
Trigger details
Details required from the Birdeye client
Triggers Supported
PracticePanther Organization ID
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 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 the Location ID, hover over the ‘Status’ of the location.
Integration Process
Before you can integrate PracticePanther 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 PracticePanther 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.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
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 the curl command, use this command.
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 the changes if required.
Status: It shows integration status (Active or Inactive).
Frequency: The number of times integration will sync with CRM (Days or Hours).
Next RunTime: The next scheduled time is when the integrations will run.
Location Name: The name of the location needs to be integrated.
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.’
Once we set up the integration on the dashboard, we need to contact the customer and assist them in creating the custom Field on PracticePanther CRM.
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
For Single Location Accounts
To complete the process, click on the 'Settings' tab 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 a particular location, it will redirect you to that location. Now, scroll down to the ‘CRM Integrations’, and click on the ‘Authorize PracticePanther’ button to authorize the business.
After you click the authorization button, you will be redirected to the PracticePanther website. Enter the email address and password associated with your PracticePanther account and click on the 'Login' button.
Once you have signed in to your PracticePanther account, Birdeye will ask for permission to obtain client data from your Panther 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 PracticePanther.
If you want to send review requests for selected matters, you have the ability to create a custom field within your PracticePanther account. To create a custom field, click on the 'Name' icon on the top right corner, and from the drop-down menu, click on the 'Settings' button.
On the 'Settings' page, click on the 'Custom Fields' tab, which appears on the left navigation rail.
To create a new custom field for new matters, click on the 'New Matter Field' button at the bottom of the screen.
Enter 'Don't send review' in the name field and select 'Checkbox' as type. Before saving the selection, click on the 'Show more information' icon to add a help text to the custom field.
Adding a 'TOOLTIP' and 'HELP TEXT' ensures consistency and accuracy of the newly created custom field. Once you have added text in the required boxes, click on the 'Save' button on the bottom to save the custom field.
The 'Don't send review' custom field will appear every time you are in the process of creating a new matter. To avoid sending a review request for a particular matter, check this field before saving the matter.
For Enterprise Businesses
To ensure matters are mapped to the right business location, it is essential to create a custom field within your PracticePanther account. To create a new custom field, click on the 'New Matter Field' button on the 'Custom Fields' page.
Enter 'Location' in the name field and select 'Drop Down List' as the type. In the 'List Options' field, enter the name of all your business locations. Before saving the selection, click on the 'Show more information' icon to add a help text to the custom field.
Adding a 'TOOLTIP' and 'HELP TEXT' ensures consistency and accuracy of the newly created custom field.
NOTE: Don't forget to turn the 'Always Visible' and 'Required' buttons to 'Yes' before saving your selection.
The 'Location' custom field will appear every time you are in the process of creating a new matter. To map a matter to a particular location, select the right location from the drop-down menu.
Curl Commands
Before integrating Practice Panther 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 an Integration Group (SMB & Enterprise)
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" : 18,
"integrationGroupTriggers":[{"triggerId":18,"triggerTypeId":1}]}'151544645328379 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location account.
18 - Integration Trigger ID - Integration Trigger ID - Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for SiteLink. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Curl command in the case of a new custom field name (SMB Business)
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" : 18, "integrationGroupTriggers":[{"triggerId":18,"triggerTypeId":1}],"integrationGroupProperties" :[{"propertyKey" :"practice.panther.custom.field.dont.send.review","propertyValue" :"No review requests"},{"propertyKey" :"practice.panther.location.custom.field.name","propertyValue" :"Sign Appt Location"}]}'151544645328379 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location account.
No review requests - Don't Send Review - Add the integration property if the customer uses any other name apart from ‘Don’t send review’ for the custom field.
18 - Integration Trigger ID - Integration Trigger ID - Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for SiteLink. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Sign Appt Location - Location Custom Field Name - Add the integration property if the customer is using any other name apart from ‘Location’’ for the custom field.
Curl command in the case of a new custom field name (Enterprise Business)
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" : 18, "integrationGroupTriggers":[{"triggerId":18,"triggerTypeId":1}],"integrationGroupProperties" :[{"propertyKey" :"practice.panther.custom.field.dont.send.review","propertyValue" :"No review requests"},
{"propertyKey" :"practice.panther.location.custom.field.name","propertyValue" :"Sign Appt Location"}]}'151544645328379 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location account.
No review requests - panther.custom.field.dont.send.review - Add the integration property if the customer uses any other name apart from ‘Don’t send review’ for the custom field.
18 - Integration Trigger ID - Ask the client what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for SiteLink. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Sign Appt Location - Location Custom Field Name - Add the integration property if the customer uses any other name apart from ‘Location’’ for the custom field.
Fetch information for all the triggers available for PracticePanther (Curl Command)
Copy this Curl Command
curl -X GEThttps://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/18 -H 'cache-control: no-cache' -H 'content-type: application/json'
Sample response: A sample response like this (see below) will 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": 18,
"integrationSourceId": 18,
"triggerService": "practicePantherClosedMatterTriggerService",
"displayName": "PracticePanther Closed Matter Trigger",
"description": "This trigger is used to fetch customer data based on the closed matters",
"active": true,
"integrationSourceName": "PracticePanther",
"integrationTriggerType":[{"id":1,"name":"JOB"}]
}
]18 - Trigger IDs
Update triggers in the 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": 133,"integrationGroupTriggers":[{"triggerId":117,"triggerTypeId":1}]}'replaceTriggers=true -
133 - Group ID - The Group ID which was returned in the previous step will be entered here.
117 - Enter the Trigger ID(s) which need to be added or updated to the integration.
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/151544645328379 -H 'Cache-Control: no-cache'
151544645328379 - Business ID: Enter the Business ID here to get the integration group details for a business.
Sample Response:
[
{
"groupId": 133,
"integrationSourceType": {
"id": 18,
"integrationSource": "PRACTICEPANTHER",
"sourceCategory": "Legal",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 18,
"triggerTypeId": 1
}
]
}
]133 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for the business.
Integration Mapping
This configuration is developed to create the actual business integration mapping. Each business integration mapping corresponds to an individual business location.
Integration Mapping - SMB Business
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": 151544645328379,"active": true,"integrationGroupId": 133}'151544645328379 - Business ID- Enter the Business ID here.
133 - Group ID- Enter the Group ID that was returned when the Integration group was created.
Integration Mapping - Enterprise Business
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": 151544645328379,"active": true,"integrationGroupId": 133,"integrationProperties":[{"propertyKey":"practice.panther.location.name","propertyValue":"NY","isSecure":false}]}'151544645328379-Business ID- Enter the Business ID here.
133-Integration Group ID- Enter the Group ID, which was returned when the Integration group was created.
NY - Location name: Enter the name of the location which needs to be integrated.
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 PracticePanther are:
Custom field ref is don't send review, and the custom field value is true
Integration is beta
Description
The value of the custom field (Don’t send) value is true.
The integration setup is currently set to beta.



























