*This integration is supported for both SMB & Enterprise businesses

Integrating BirdEye with Rocket Matter
User Manual

Introduction

Integration Requirements

Details required from the BirdEye client
- Triggers Supported
- Rocket Matter Organization ID
- Location names for multi-location account
- Location custom field name for multi-location account
Details required from the BirdEye dashboard
- Enterprise ID for multi-location account and Business IDs for all locations
- Business ID in case of a single-location account

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)

Integration Mapping

Single location (Curl Command)
Multi-location (Curl Command)

Complete Integration within BirdEye dashboard

Introduction

Rocket Matter is a cloud-based legal case management and billing software used by both small and medium-sized law firms. It offers various features including billing management, tracking, payments, calendar etc. Integrating Rocket Matter with BirdEye will automate the process of sending out review requests to clients on a daily basis.

Once Rocket Matter is integrated with BirdEye, BirdEye will pull client information from Rocket Matter once daily from the matters that were closed/completed 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.

Integration Requirements:

Triggers supported

BirdEye allows you to fetch data from your CRM using some predefined triggers. You can choose any combination from the list of available triggers and inform the support team about your selection. Here is the supported trigger for Rocket Matter:

Trigger Name	Trigger Description
Rocket Matter Closed or Completed Matter Trigger	This trigger is used to fetch customer data based on the closed or completed matters.

Information from BirdEye Dashboard

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

Enterprise ID

Business IDs of all locations

Integration process

Before integrating RocketMatter 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)

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" :150088776180458,"integrationSourceId" : 16,"integrationGroupTriggers":[{"triggerId":16,"triggerTypeId":1}], "integrationGroupProperties" :[{"propertyKey" : "send.rr.matter.status","propertyValue": "Closed,Completed"}]}'

150088776180458 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
16 - 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 Rocket Matter. Identify the trigger Id(s) and insert (use commas) in case of multiple trigger Ids.
Closed,Completed - rr.matter.status - The value for this integration property can be either Closed, Completed, or both Closed, Completed.

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 required while we will be doing the integration mapping.

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

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/16 -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": 16,
"integrationSourceId": 16,
"triggerService": "rocketMatterClosedOrCompletedMatterTriggerService",
"displayName": "RocketMatter Closed or Completed Matter Trigger",
"description": "This trigger is used to fetch customer data based on the closed or completed matters",
"active": true,
"integrationSourceName": "Rocket Matter",
"integrationTriggerType":[{"id":1,"name":"JOB"}]
}
]

16 - Trigger ID

(c) Curl command to update triggers in the integration group

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": 150,"integrationGroupTriggers":[{"triggerId":10,"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.
150 - The Group ID which was returned in the previous step will be entered here.
10 - Enter the Trigger ID (s) which need to be added or updated to the integration.

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

Copy this Curl Command

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

150088776180458 - Business ID: Enter the Business ID here to get the integration group details for a business.

Sample Response

[
{
"groupId": 150,
"integrationSourceType": {
"id": 16,
"integrationSource": "ROCKETMATTER",
"sourceCategory": "Legal",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 16,
"triggerTypeId": 1
}
] }
]

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

Business Integration Mapping

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

Integration Mapping - How it works (SMB 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": 150088776180458,"active": true,"integrationGroupId": 150}'

150088776180458 - Business ID- Enter the Business ID here.
150 - Group ID- Enter the Group ID that was returned when the Integration group was created.

Integration Mapping - How it works (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": 151544645328379,"active": true,"integrationGroupId": 150,"integrationProperties":[{"propertyKey" : "rocket.matter.location.custom.field.name","propertyValue": "Location Name"},{"propertyKey" : "rocket.matter.location.names","propertyValue": "palo alto,sacramento"}]}'

151544645328379-Business ID- Enter the Business ID here.
150-Group ID- Enter the Group ID which was returned when the Integration group was created.
palo alto,sacramento - Location names - Enter the name of the locations(comma separated) which needs to integrated corresponds to given business number(will be provided by client)
Location Name - Location Custom Field Name - Add this property that client is using for location custom field(will be provided by client).

Dashboard Setup

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

Single-location account

After the initial integration is set up by the BirdEye technical support team, you can 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. On the bottom of the ‘Settings’ page, click on the 'Authorize Rocket Matter ' button under the CRM integrations header.

After you click on the authorization button, you will be redirected to the Rocket Matter website. Enter the Username and Password associated with your Rocket Matter account and click on the 'Login' button.

Once you have logged in to your Rocket Matter account, click on the 'Allow' button to give BirdEye the permission to access your data.

After you have authorized BirdEye, you will see an ‘Authorized' message next to Rocket Matter.

BirdEye also gives you the ability to select the matters for which you don't want to send the review request to your clients. You can do this in two ways:

By creating a custom field within your Rocket Matter account
By creating a custom field within a matter

To create a custom field within your Rocket Matter account, click on the 'Settings' tab on the left navigation rail.

Once on the 'Settings' page, click on the 'Manage Custom Fields' button on the bottom right.

On the new page, click on the 'Add Custom Field' button under the 'Matter Fields' header.

Now, enter 'Send Review' in the custom field text box and click on the 'OK' button on the bottom right.

After the custom field is created, you will see a 'Send Review' option for all the matters created using your Rocket Matter account. If you don't wish to send review request for a matter, click on the 'Edit Values' button on the top right.

Now, input 'No' next to the 'Send Review' custom field and click on the 'Save Changes' button on the top right.

NOTE: If no value or anything other than 'No' is entered in the custom field, the review request will be sent to the customer.

Adding a custom field to a matter

To add a custom field to a single matter, click on the 'Matters' tab on the left navigation rail of your BirdEye dashboard and click on an existing matter.

Under the 'Matter Custom Fields' header, you have the ability to add a new custom field by clicking on the 'Plus' icon on the extreme right.

Name the new field as 'Send Review' and input 'No' as the value if you don't wish to send review request for this matter. Once you have made the changes, click on the 'Save changes' button on the top right.

Multi-location account

In the case of a multi-location account, you will need a location custom field to ensure matters are mapped to the right business location. To create a location custom field, enter 'Location Name' in the text box and click on the 'OK' button.

After the custom field is created, you will see a 'Location Name' option for all the matters created using the Rocket Matter account.

Once you are in the process of creating a matter, click on the 'Edit Values' button and enter the name of the location corresponding to the matter. After you have entered the name of the location, click on the 'Save Changes' button on the top right.

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