*This integration is supported for both SMB & Enterprise businesses.

Integrating BirdEye with Litify
User Manual

*SUPPORT ARTICLE

Integration Requirements

Information required from the BirdEye client

Location Field Name(Mandatory for Multi-location setup)
Location Name(Mandatory for Multi-location setup)
Review Request Field Name(Optional)
Supported Trigger

Details required from the BirdEye dashboard

Enterprise ID for multi-location account and Business IDs for all locations
Business ID in the case of an SMB business

Integration Process

Business Integration Group

Create Integration Group (Curl Command)
Fetch information for all the triggers (Curl Command)
Find business integration group details (Curl Command)
Update Trigger Information (Curl Command)

Business Integration Mapping

How it works
Finding the Location Name

Complete Integration within BirdEye dashboard

Introduction

Litify is a practice management solution (PMS) used by attorneys and paralegals to manage the entire lifecycle of each case. Litify offers a host of features to manage caseloads, client outcomes, real-time reporting, reminders and more.

BirdEye can seamlessly integrate with your Litify account and send out review requests to your clients automatically. Integrating Litify with BirdEye will automate the process of sending out review requests to your clients on a daily basis.

Integration Requirements

Supported triggers

BirdEye allows you to fetch data from your CRM using some predefined triggers. Here is the supported trigger for Litify:

Trigger Name	Trigger Description
Litify Closed Matter Trigger	This trigger is used to used to fetch closed matter from Litify

Information required from BirdEye Dashboard

For single location SMB account - Business ID
For multi-location account - Enterprise ID of all locations

Enterprise ID

Integration process

Before you can integrate Litify with BirdEye, you will need to set up following configurations:

Business Integration Group: 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 business integration group allows you to associate multiple business locations with the Enterprise account. Below are the list of curl commands that you will need to run to set this up.

(a) Create Integration Group (Curl Command)

For (Single location businesses)

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": 157830527666739,
"integrationSourceId": 72,
"integrationGroupTriggers": [
{
"actionIds": [
1
],
"triggerId": 86,
"triggerTypeId": 1
}
],
"integrationGroupProperties": [{"propertyKey": "review_request_identifier","propertyValue": "Review_Request__c"}]
}'

157830527666739 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
86- Integration Trigger ID - It represents the trigger ID for the Litify Trigger.
Review_Request__c- Send Review Request Field Name(Optional) - If the client wants a custom setup in which he/she wants to send a review request to only customers with a particular custom key marked so we can provide it here.

For (Multi-location businesses)

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": 157830527666739,
"integrationSourceId": 72,
"integrationGroupTriggers": [
{
"actionIds": [
1
],
"triggerId": 86,
"triggerTypeId": 1
}
],
"integrationGroupProperties": [{"propertyKey": "location_identifier","propertyValue": "Region__c"}, {"propertyKey": "review_request_identifier","propertyValue": "Review_Request__c"}]
}'

157830527666739 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
86- Integration Trigger ID - It represents the trigger ID for the Litify Trigger.
Region__c - Location Field Name(Only in case of Multi-location) - For multi-location setup, the client would be using a Custom Field on Litify, so client would be providing this value, Eg: Region__c
Review_Request__c - Send Review Request Field Name(Optional) - If the client wants a custom setup in which he/she wants to send a review request to only customers with a particular custom key marked so we can provide it here. See below for details.

NOTE: We will get the group ID once we run the first curl (Integration Group) and make a note of group ID as that will be required while we will be doing the integration mapping.

How to find the Send Review Request Field Name in Salesforce

After the CustomField has been made, look for the Field Name also known as API name which is different from the Label name. For many cases, it has the suffix __c.

(b) Fetch information for all the triggers available for Litify (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/15 -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 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": 86,
"integrationSourceId": 72,
"triggerService": "litifyClosedMatterTriggerService",
"displayName": "Litify Closed Matter Trigger Service",
"description": "This trigger is used to fetch closed matter from Litify",
"active": true,
"integrationSourceName": "Litify",
"integrationTriggerType":[{"id":1,"name":"JOB"}]
}]

86 - Trigger IDs

(c) Find business integration group details (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/149581663020602 -H 'Cache-Control: no-cache'

149581663020602 - Business ID: Enter the Business ID here to get the integration group ID for the business.

Sample Response

[
 {
"groupId": 142,
"integrationSourceType": {
"id": 15,
"integrationSource": "LITIFY",
"sourceCategory": "Law",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 86,
"triggerTypeId": 1
}
]
}]

142 - Group ID: A group ID will be returned in the sample response with the details of the existing trigger for the business.

Business Integration Mapping (Single location businesses)

This configuration is developed to create the actual business integration mapping for single-location businesses or SMBs.

How it works

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,"active": true,"integrationGroupId" : 25}'

151980725935863- Business ID- Enter the Business ID here.
25 - Group ID- Enter the Group ID that was returned when the Integration group was created.

Business Integration Mapping (Multi-location businesses)

This configuration is developed to create the actual business integration mapping. Each business integration mapping corresponds to an individual business location.

How it works

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,"active": true,"integrationGroupId" : 25, "integrationProperties": [{"propertyKey": "location_id","propertyValue": "Colorado|Denver"}]}'

151980725935863- Business ID- Enter the Business ID here.
25 - Group ID- Enter the Group ID that was returned when the Integration group was created.
Colorado|Denver - Location Id- For a Multi-location setup you have to provide the location name for location from the Litify Platform, client will be providing it. More than one location name can be added separated by pipe ( | )

Complete Integration within BirdEye dashboard

The rest of the setup is to be completed within the businesses BirdEye dashboard:

Log in to your BirdEye account and click on the 'Settings' tab on the left navigation rail. On the bottom of the 'Settings' page, click on the 'Authorize Litify' button under the CRM integrations header.

*Be Sure that the Client or Support team is authorizing the Client’s Litify Salesforce account(providing litify salesforce credentials while Login to Salesforce) and not some random Salesforce account.

You will be redirected to the Litify login screen. Enter your login credentials and click on the ‘Log In’ button at the bottom.

On the next screen, you need to grant BirdEye access to your data on Litify. Click on the ‘Allow’ button to proceed.

Now you will be redirected to the BirdEye account. You will be able to view an ‘Authorized’ status next to Litify.

Review Request Checkbox Setup

On the Client's Litify instance, create a custom checkbox named as Send Review Request, then pass on the api name which will be such as Review_Request__c in the Review Request Field Property in Integration Dashboard as shown below(4th Property). The checkbox can be set as default true so it will always be ticked true and clients can unmark them if they don't want to send a review request.

How to find the Send Review Request Or Location Identifier Field Name in Salesforce

After the CustomField has been made or is already present, look for the Field Name also known as API name which is different from the Label name. For many cases, it has the suffix __c. In the case of Enterprise, location identifiers we also need to collect the possible values for the location field picklist. The field would be present at Objects & Fields > Object Manager > Matter > Fields & Relationships

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 checkedIn contacts.

Litify Campaign tags are:

matter_status, matter_closed_reason, matter_gross_recovery, matter_client_payout

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 Litify are: