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 only supported for SMB businesses.
Integrating Birdeye with HawkSoft
User Manual - SUPPORT ARTICLE
HawkSoft is an insurance agency management system which offers various features, including contact management, claims management, and insurance policy management. Birdeye can seamlessly integrate with your HawkSoft account and automatically send review solicitations to your clients. Once Birdeye is integrated with HawkSoft, Birdeye will fetch customer information from HawkSoft.
Birdeye collects the first name, last name, email address and phone number of the clients and automatically sends them review requests based on the preferences set within the Birdeye account.
Table of Contents
Triggers Supported
Information required from the Business
Information from Birdeye dashboard
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers Supported
Birdeye allows you to fetch data from your CRM using a predefined trigger. Here is the supported trigger for HawkSoft:
Trigger Display Name | Trigger Name/Value | Trigger Description |
HawkSoft Policy Trigger | Policy Trigger | This trigger is used to fetch the client's policy details from HawkSoft. |
Details required from the HawkSoft dashboard
Trigger details
Office ID
Agency ID
Details required from the Birdeye dashboard
Business ID in case of an SMB Business
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.’
The ‘Business ID’ and ‘API key’ are shown in the image.
Integration process
Before you can integrate HawkSoft 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 HawkSoft CRM in the search bar and select it. Click on ‘Next’.
Manage Triggers
The trigger is automatically selected as only one trigger is supported.
Manage Properties
Here; you can manage group-level properties, which will be applied to all locations under a CRM.
Agency ID: Enter the client's Agency ID provided by the company.
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.
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, 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.
Office ID: Enter the office ID in case of enterprise business.
Policy Status: Enter the policy status for which to send the review requests.
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.’
NOTE: For SMB: You can use ‘manage the locations’ using this curl command.
Curl Commands
Before you can integrate HawkSoft 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 (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": 150088776180458, "integrationSourceId": 95, "integrationGroupProperties": [{ "propertyKey": "agency_id", "propertyValue": "939393", "isSecure": false}],"integrationGroupTriggers":[{"triggerId":109,"triggerTypeId":1}]}'150088776180458 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account.
939393 - Agency ID: This Agency ID will be shared by the business.
109 - Integration Trigger ID - Trigger available for HawkSoft.
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'
Sample Response:
[
{
"groupId": 155,
"integrationSourceType": {
"id": 95,
"integrationSource": "HAWKSOFT",
"sourceCategory": "Others",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 109,
"triggerTypeId": 1
}
],
"integrationGroupProperties": [{ "propertyKey": "agency_id", "propertyValue": "939393", "isSecure": false}]
}
]155 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
Integration Mapping
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/businessintegrationmappin -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d '{"businessNumber": 150088776180458,"active": true,"integrationGroupId": 26}'150088776180458 - Business ID: Enter the Business ID for the SMB Business.
26 - Group ID: Enter the Group ID, which was returned when the Integration group was created.
Find the Agency Id
In the marketplace,
Search for Hawksoft Data Sync
Customer Id is the Agency Id