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 Eagle Software
User Manual - SUPPORT ARTICLE
Eagle Software is a real estate CRM hosted in the cloud. It provides a flexible cloud-based platform for real estate owners, companies, property investors, and operators, including residential and commercial property management, sales trust accounting and marketing, real estate websites, lease tools, Facebook applications, sales, lettings and more.
Birdeye can seamlessly integrate with your Eagle Software account and send out review solicitations to your patients automatically. Integrating Eagle Software with Birdeye will automate the process of sending out review requests to patients daily.
Table of Contents
Triggers Supported
Information from Birdeye dashboard
Login
Manage Triggers
Manage Properties
Manage Locations
Setup Through Birdeye Dashboard
Important Instructions for Email and SMS opt-in/ opt-out.
Integration Requirements
Triggers supported
Birdeye allow you to fetch data from your CRM using a predefined trigger. Here are the supported triggers for Eagle Software:
Trigger Display Name | Trigger Name/Value | Trigger Description |
EagleSoftware Sold Property Trigger | Sold Property | This trigger is used to fetch contacts of Sold Property contacts within a specified date range. |
EagleSoftware Lease Property Trigger | Lease Property | This trigger is used to fetch contacts of Lease Property contacts within a specified date range. |
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 Eagle Software 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 successfully logging in to the integration dashboard, you have to click on ‘BE integration’ and then ‘Add Integration.’
Search for the Eagle Software 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).
Client ID: Add the client-supplied ClientID.
Client Secret: Add the Client Secret that the client provided.
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 changes if required.
Status: It shows the integration status (Active or inactive).
Frequency: The number of times integration will sync with CRM (days or hours).
Next RunTime: It is the next scheduled time when the integration will run.
Property Listing Type: Enter the comma-separated listing types for sold and lease trigger for which you want to send the review request.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Office ID: Enter the office ID provided by the client.
NOTE:It is mandatory for Enterprise businesses.
Comma-separated values are not allowed.
Override Group Properties: With this, you can override the API Key.
Click on ‘Next’ and click on ‘Save.’
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.
Authorize through Integration Dashboard
Upon creating a new Eagle Software group for the first time from the integrations dashboard, the system will automatically attempt to authorize the group. If the group properties (like client_id, and client_secret) provided are correct, the authorization will succeed. This will be evident from the fact that the Eagle Software group will be indicated as authorized, and no further action needs to be taken.
In case the group is unable to be authorised the first time it’s created or is unauthorised at a later stage, please authorise it again by following the steps below.
Setup through Integration Dashboard
The rest of the setup is to be completed within the Integration dashboard:
Once in the Birdeye dashboard, click on the ‘BE Integrations’ tab on the left navigation rail.
Scroll to the ‘Eagle Software’ integration and hover over the three dots.
Click on the ‘Actions’ drop-down button and select the ‘Authorize’ option.
Once you select the authorize option, the integration will be authorized.
Curl Commands
Before you can integrate Eagle Software 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 for SMB Business (Curl Command)
Copy this Curl Command
curl --location --request PUT 'https://common-services.Birdeye.com/integration/add/businessintegrationgroup' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"parentBusinessNumber": 155802718182498,
"integrationSourceId": 126,
"integrationGroupProperties": [
{
"propertyKey": "eagle.software.client.id",
"propertyValue": "e11f24abc6849aca634f0f14",
"isSecure": false
},
{
"propertyKey": "eagle.software.client.secret",
"propertyValue": "2665513dfafed36f1ad1179ac7c04afd269efb061f7d9e6584cc54b0d0859354",
"isSecure": false
},
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"integrationGroupTriggers": [
{
"triggerId": 142,
"triggerTypeId": 1
},
{
"triggerId": 143,
"triggerTypeId": 1
}
]
}'155802718182498 - Business ID - This is a Business ID for a single location SMB account
142, 143 - 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 Eagle Software. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Create Integration Group for Enterprise Business (Curl Command)
Copy this Curl Command
curl --location --request PUT 'https://common-services.Birdeye.com/integration/add/businessintegrationgroup' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"parentBusinessNumber": 155802718182498,
"integrationSourceId": 126,
"integrationGroupProperties": [
{
"propertyKey": "eagle.software.client.id",
"propertyValue": "e11f24abc6849aca634f0f14",
"isSecure": false
},
{
"propertyKey": "eagle.software.client.secret",
"propertyValue": "2665513dfafed36f1ad1179ac7c04afd269efb061f7d9e6584cc54b0d0859354",
"isSecure": false
},
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"integrationGroupTriggers": [
{
"triggerId": 142,
"triggerTypeId": 1
},
{
"triggerId": 143,
"triggerTypeId": 1
}
]
}'155802718182498 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account.
142, 143 - Integration Trigger ID - This 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 Eagle Software. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for Eagle Software (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/126' \ --header 'cache-control: no-cache' \ --header '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": 143,
"triggerService": "eagleSoftwareSoldPropertyTriggerService",
"displayName": "EagleSoftware Sold Property Trigger",
"description": "This trigger is used to fetch contacts of Sold Property contacts within specified date range",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
126
],
"triggerName": "Sold Property",
"caseTypeId": 1
},
{
"id": 142,
"triggerService": "eagleSoftwareLeasedPropertyTriggerService",
"displayName": "EagleSoftware Lease Property Trigger",
"description": "This trigger is used to fetch contacts of Lease Property contacts within specified date range",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
126
],
"triggerName": "Lease Property",
"caseTypeId": 1
}
]Find business integration group details (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.birdeye.com/integration/businessintegrationgroup/155802718182498' \ --header 'Cache-Control: no-cache'
Sample Response
{
"groupId": 24181,
"integrationSourceType": {
"id": 126,
"integrationSource": "EAGLESOFTWARE",
"sourceCategory": "Real Estate",
"integrationType": "Birdeye API",
"integrationPlan": "Standard",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 142,
"triggerTypeId": 1,
"actionIds": [
1
]
},
{
"triggerId": 143,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
},
{
"groupId": 24190,
"integrationSourceType": {
"id": 62,
"integrationSource": "DEALERTRACK",
"sourceCategory": "Other",
"integrationType": "Birdeye API",
"integrationPlan": "Premium",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 86,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
}
]24190 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
155802718182498 - Business ID: Enter the Business ID here to get the integration group details for a business.
Trigger Information: Only required if the client wants a change (Curl Command)
Copy this Curl Command
curl --location --request POST 'https://common-services.birdeye.com/integration/update/businessintegrationgroup?replaceTriggers=true' \
--header 'cache-control: no-cache' \
--header 'content-type: application/json' \
--data-raw '{
"groupId": 24181,
"integrationGroupTriggers": [
{
"triggerId": 142,
"triggerTypeId": 1
},
{
"triggerId": 143,
"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.
24181 - Group ID: The Group ID which was returned in the previous step will be entered here.
142, 143 - Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Mapping (SMB Businesses)
Once the Integration Group is created, the next step is to create the Integration Mapping.
Copy this Curl Command
curl --location --request PUT 'https://common-services.birdeye.com/integration/add/businessintegrationmapping' \
--header 'Content-Type: application/json' \
--data-raw '{
"businessNumber":160283190794732,
"integrationGroupId": 24181,
"integrationProperties": [
{
"propertyKey": "eagle.software.listing.type",
"propertyValue": "Land",
"isSecure": false,
"triggerId": 142
},
{
"propertyKey": "eagle.software.listing.type",
"propertyValue": "Land",
"isSecure": false,
"triggerId": 143
},
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"active": true,
"test": false,
"beta": false
}'155802718182498 - Business ID: Enter the Business ID for the SMB Business.
24181 - Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.
Integration Mapping (Enterprise Businesses)
Copy this Curl Command
curl --location --request PUT 'https://common-services.birdeye.com/integration/add/businessintegrationmapping' \
--header 'Content-Type: application/json' \
--data-raw '{
"businessNumber":160283190794732,
"integrationGroupId": 24181,
"integrationProperties": [
{
"propertyKey": "eagle.software.listing.type",
"propertyValue": "Land",
"isSecure": false,
"triggerId": 142
},
{
"propertyKey": "eagle.software.listing.type",
"propertyValue": "Land",
"isSecure": false,
"triggerId": 143
},
{
"propertyKey": "customer.fetch.delay",
"propertyValue": "0",
"isSecure": false
}
],
"active": true,
"test": false,
"beta": false
}'155802718182498- Business ID: Enter the Business ID.
24181 - Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.
Restriction Reason
Restriction reason is used to identify the contacts who have 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 Eagle Software are:
The customer is inactive
Integration is beta
The listing type is not configured in the Property listing type field.
Description
The customer is inactive.
Integration is beta.
The listing type is not configured in the Property Listing type field (e.g. Land, commercial).
Troubleshooting steps
If you encounter any of the above restriction reasons, please search the following keys to know the reason for restricting the contact.
Customer is inactive.
Check whether the customer is active or not.Integration is beta.
Please look up the key beta in kibana to know whether the integration is beta or not.Listing type is not configured in the Property Listing type field.
Provide the listing type in the Property Listing type field you want to send the review request.