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 SMBs only.
Integrating Birdeye with Follow Up Boss
User Manual - SUPPORT ARTICLE
Follow Up Boss is a real estate CRM and lead management software. The CRM comes with a host of features, including calendar management, email marketing, contact management, etc. Birdeye can seamlessly integrate with your Follow Up Boss account and automatically send review solicitations to your customers. Once Birdeye is integrated with Follow Up Boss, Birdeye will fetch customer information from Follow Up Boss.
Birdeye collects the client's first name, last name, email address, and phone number and automatically sends them to review requests based on the preferences set within the Birdeye account.
Table of Contents
Triggers Supported
Information required from the Business
Login
Manage Triggers
Manage Properties
Manage Locations
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 Follow Up Boss:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Follow Up Boss Closed Deals Trigger | Closed Deal | This trigger is used to fetch customer data based on closed deals. |
Follow Up Boss People Trigger | People’s Stage | This trigger is used to fetch customer data based on the people's stage name. |
Details required from the Follow Up Boss dashboard
Trigger details
Follow Up Boss API Key
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.’
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 Location ID, hover over the ‘Status’ of location.
Fetch the API Key from Follow Up Boss account
Log in to your Follow Up Boss account and click on the 'Admin' tab on the top panel.
On the 'Admin' page, hover over the 'More' icon and click on the 'API' button from the drop-down menu.
The API Key for your Follow Up Boss account will appear under the 'API Settings' header. Use the 'Copy' button to move the API Key securely.
Integration Process
Before you can integrate Follow Up Boss 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 the CRM in the search bar and select it. Click on ‘Next’.
Manage Triggers
Select the Trigger Name (Check Box) 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 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).
Stage name: Enter the stage name provided by the customer for which the customer wants the review requests to be sent. Add stage name for ‘Closed Deals’ trigger as well as ‘People’ trigger
API key: Enter the customer-provided API key or click on the link to fetch the Follow Up Boss API key.
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 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 the status of Integration (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.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Override Group Properties: With this, you can override the properties added at the group level, specific to each location.
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.
Curl Commands
Before you can integrate Follow Up Boss 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 are the 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": 20, "integrationGroupProperties": [{ "propertyKey": "stage", "propertyValue": "Closed, Closed-Lost", “triggerId”: 23}, { "propertyKey": "stage", "propertyValue": "Lead, In Escrow", “triggerId”: 92}, { "propertyKey": "followupboss_api_key", "propertyValue": "3858dd3c4834fed742e0b017038d56599cf814", "isSecure": false}],"integrationGroupTriggers":[{"triggerId":23,"triggerTypeId":1},{"triggerId":92,"triggerTypeId":1}]}'150088776180458 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
3858dd3c4834fed742e0b017038d56599cf814 - Follow Up Boss API Key: This API Key will be shared by the business on the initial integration call.
23,92 - 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 Follow Up Boss. Identify the trigger ID (s) and insert (use commas) in case of multiple trigger Ids.
Closed, Closed-Lost - Review Request will be sent only to customers associated with a deal having this configured custom deal stage. Configuring Multiple stages separated by Comma is also supported.
Lead, In Escrow - Review request would be sent only to those customers having this configured stage. Rest will be checked in to Birdeye but restricted from being sent a Review Request. Configuring Multiple stages separated by Comma is also supported.
Fetch information for all the triggers available for Follow Up Boss (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/20 -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 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": 92,
"triggerService": "followUpBossPeopleTriggerService",
"displayName": "Follow Up Boss People Trigger",
"description": "This trigger is used to fetch customer data based on the people's stage name.",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
20
],
"triggerName": "People's Stage"
},
{
"id": 23,
"triggerService": "followUpBossClosedDealsTriggerService",
"displayName": "Follow Up Boss Closed Deals Trigger",
"description": "This trigger is used to fetch customer data based on the closed deals.",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
20
],
"triggerName": "Closed Deal"
}
]23, 92 - Trigger ID
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.
Sample Response:
[
{
"groupId": 155,
"integrationSourceType": {
"id": 20,
"integrationSource": "FOLLOWUPBOSS",
"sourceCategory": "Real Estate",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 23,
"triggerTypeId": 1
},
{
"triggerId": 92,
"triggerTypeId": 1
}
]
}
]155 - 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 the 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": 26,"integrationGroupTriggers":[{"triggerId":23,"triggerTypeId":1},{"triggerId":92,"triggerTypeId":1}]}'replaceTriggers=true - To replace existing trigger(s), enter the value for replaceTriggers as true. To add a new trigger(s) to the existing list, the value for replaceTriggers should be false.
26 - Group ID: The Group ID which was returned in the previous step will be entered here.
23, 92 - Trigger ID: Enter the Trigger ID(s) which need to be added or updated in the integration.
Integration Location 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/businessintegrationmapping -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.
Re-Authorise Business
Sometimes, the credentials entered were wrong during setup or expired, so we receive 401 Unauthorized Error while running the Integration, and as a result, Integration will be marked unauthorized. It will not run until the credentials are corrected, and the business is authorized again, which involves the steps given in the below document.
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 Followup Boss are
The stage name is not allowed
Integration is beta
Description
The stage name does not match the configured deal/contact stage.