*This integration is supported for both SMB & Enterprise businesses.
Integrating BirdEye with Entrata
User Manual
INTEGRATION PREREQUISITE: As a prerequisite to set up the integration with Entrata, an email needs to be sent to legal@entrata.com by the client, post which Entrata API team will create a client database for that business and will provide the user ID access. Client needs to send this setup request(Request Template). Only after the business’ permission and user ID creation, we can fetch the data and the access to the 3rd party API will be permitted.
Table of Contents
Introduction
Integration Requirements
Details required from the BirdEye client
Triggers Supported
Entrata login credentials
Entrata Domain Name
Entrata Property ID
Details required from the BirdEye dashboard
Enterprise ID for multi-location accounts and Business ID for all locations
Business ID in case of a single-location account
Integration Process
Business Integration Group
Create Integration Group (Without customization)
Create Integration Group (With customization)
Fetch information for all the triggers available for Entrata (Curl Command)
Find business integration group details (Curl Command)
Update Trigger Information (Curl Command)
Integration Mapping
Introduction
Entrata is a property management software that aims at making life easier for property owners, property managers, and residents. Serving both residential and commercial companies, the deeply integrated software solution offers a myriad of features including, billing and invoicing, insurance management, contact management, lease management, etc.
BirdEye supports seamless integration with your Entrata account and helps you to solicit reviews from your customers automatically. To automate the process of sending out review solicitation emails or survey requests, you need to integrate Entrata with BirdEye.
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 are the supported triggers for Entrata:
Trigger Name | Trigger Description |
Entrata Closed Work Orders Trigger | This trigger is used to fetch customer data based on closed work orders. |
Entrata On Site Visit Trigger | This trigger is used to fetch customer data based on site visits. |
Entrata Move In Trigger | This trigger is used to fetch customer data based on move in. |
Entrata Notice Trigger | This trigger is used to fetch customer data based on notice. |
Entrata Move Out Trigger | This trigger is used to fetch customer data based on move out. |
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 Entrata with BirdEye, you will need to set up following configurations:
1. 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 a 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 an Integration Group (Without customization)
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' -H 'postman-token: fc4ee322-fb7a-046d-bdc0-7ef2fd737edc' -d '{ "parentBusinessNumber": 149132411068129, "integrationSourceId": 28, "integrationGroupProperties": [{"propertyKey": "domain","propertyValue": "jrkmgmt.entrata.com"},{ "propertyKey": "username", "propertyValue": "birdeye_apiuser" },{"propertyKey": "password", "propertyValue": "$B1r5E7e_12859", "isSecure": true },{"triggerId": 43, "propertyKey": "customer.fetch.delay", "propertyValue": 1 },{"triggerId": 44, "propertyKey": "customer.fetch.delay", "propertyValue": 1 },{"triggerId": 45, "propertyKey": "customer.fetch.delay", "propertyValue": 1 },{"triggerId": 46, "propertyKey": "customer.fetch.delay", "propertyValue": 0 }], "integrationTriggers": [43, 44, 45, 46, 54 ] }'149132411068129 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location account.
Jrkmgmt.entrata.com - Domain - Will be shared by the customer on the initial setup call.
43, 44, 45, 46, 54 - 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 SiteLink. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
birdeye_apiuser - Username - Will be shared by the customer on the initial setup call.
0 - fetch.delay: Will be shared by the customer on the initial setup call for each trigger.It depicts that after how many days review requests need to be sent for each trigger
$B1r5E7e_12859 - Password - Will be shared by the customer on the initial setup call.
b) Create an Integration Group (With customization)
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' -H 'postman-token: 0d03908c-6f88-7db9-b985-794ed6c1d51d' -d '{"parentBusinessNumber": 149132411068129, "integrationSourceId": 28, "integrationGroupProperties": [{"propertyKey": "domain","propertyValue": "jrkmgmt.entrata.com"},{ "propertyKey": "username", "propertyValue": "birdeye_apiuser" },{"propertyKey": "password", "propertyValue": "$B1r5E7e_12859", "isSecure": true }, {"triggerId": 45, "propertyKey": "customer.checkin.delay.repeat1", "propertyValue":3},{"triggerId": 45, "propertyKey": "customer.fetch.delay", "propertyValue": 1}], "integrationTriggers": [43, 44, 45, 46, 54 ]}'149132411068129 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location account.
Jrkmgmt.entrata.com - Domain - Will be shared by the customer on the initial setup call.
43, 44, 45, 46, 54 - 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 SiteLink. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
3- customer.checkin.delay.repeat1 - In case of multiple check-in delays enter the required check-in delay value (in days).
birdeye_apiuser - Username - Will be shared by the customer on the initial setup call.
1 - customer.fetch.delay: Will be shared by the customer on the initial setup call for each trigger.It depicts that after how many days review requests need to be sent for each trigger
$B1r5E7e_12859 - Password - Will be shared by the customer on the initial setup call.
An example of Curl Command in case of full customization
curl -X PUT https://common-services.birdeye.com/integration/add/businessintegrationgroup  -H 'cache-control: no-cache'  -H 'content-type: application/json'  -H 'postman-token: a3aa5c07-ecf0-ac31-18eb-ab790558579b' -d '{ "parentBusinessNumber": 149132411068129, "integrationSourceId": 28, "integrationGroupProperties": [{"propertyKey": "domain","propertyValue": "jrkmgmt.entrata.com"},{ "propertyKey": "username", "propertyValue": "birdeye_apiuser" },{"propertyKey": "password", "propertyValue": "$B1r5E7e_12859", "isSecure": true },{"triggerId": 45, "propertyKey": "customer.checkin.delay.repeat1", "propertyValue":3},{ "triggerId": 45, "propertyKey": "customer.checkin.delay.repeat2", "propertyValue": 90 },{"triggerId": 45, "propertyKey": "customer.fetch.delay", "propertyValue": 0},{"triggerId": 43, "propertyKey": "customer.fetch.delay", "propertyValue": 0},{"triggerId": 44, "propertyKey": "customer.fetch.delay", "propertyValue": 0 },{ "triggerId": 46, "propertyKey": "customer.fetch.delay", "propertyValue": 0 }], "integrationTriggers": [43, 44, 45, 46, 54 ] }'c) Fetch information for all the triggers available for Entrata (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/28 -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": 43,
"integrationSourceId": 28,
"triggerService": "entrataClosedWorkOrdersTriggerService",
"displayName": "Entrata Closed Work Orders Trigger",
"description": "This trigger is used to fetch customer data based on closed work orders.",
"active": true,
"integrationSourceName": "Entrata"
}, {
"id": 44,
"integrationSourceId": 28,
"triggerService": "entrataMitLeadsOnSiteVisitTriggerService",
"displayName": "Entrata On Site Visit Trigger",
"description": "This trigger is used to fetch customer data based on site visits.",
"active": true,
"integrationSourceName": "Entrata"
}, {
"id": 45,
"integrationSourceId": 28,
"triggerService": "entrataMitLeasesMoveInTriggerService",
"displayName": "Entrata Move In Trigger",
"description": "This trigger is used to fetch customer data based on move in.",
"active": true,
"integrationSourceName": "Entrata"
},{
"id": 46,
"integrationSourceId": 28,
"triggerService": "entrataMitLeasesNoticeTriggerService",
"displayName": "Entrata Notice Trigger",
"description": "This trigger is used to fetch customer data based on notice.",
"active": true,
"integrationSourceName": "Entrata"
},
{
"id": 54,
"integrationSourceId": 28,
"triggerService": "entrataMitLeasesMoveOutTriggerService",
"displayName": "Entrata Move Out Trigger",
"description": "This trigger is used to fetch customer data based on move out.",
"active": true,
"integrationSourceName": "Entrata"
}]43, 44, 45, 46, 54 - Trigger IDs
d) Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/149132411068129 -H 'Cache-Control: no-cache'
149132411068129 - Business ID: Enter the Business ID here to get the integration group details for a business.
[
{
"groupId": 284,
"integrationSourceType": {
"id": 28,
"integrationSource": "ENTRATA",
"sourceCategory": "Real Estate",
"oauthEnabled": false
},
"integrationTriggers": [
45,
44,
46,
43,
54
]
}
]284 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for the business.
e) Update Triggers in Integration Group (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": 284,"integrationTriggers":[43, 44, 45, 46, 54]}'284 - Group ID: A group ID will be returned in the sample response with the details of the existing triggers for the business.
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.
43, 44, 45, 46, 54 - Trigger IDs - Enter the Trigger ID (s) which need to be added or updated to the integration.
2. Business Integration Mapping:
This configuration is developed to create the actual business integration mapping. Each business integration mapping corresponds to an individual business location.
Integration Mapping - How it works
Copy this Curl Command
curl -X PUT https://common-services.birdeye.com/integration/add/businessintegrationmapping -H 'content-type: application/json' -d '{"businessNumber": 149197748817256, "integrationGroupId": 284, "active": true, "officeId" : "218119"}'149197748817256 - Business ID- Enter the Business ID here.
284 - Group ID- Enter the Group ID that was returned when the Integration group was created.
218119 - Office ID- This will be the property ID provided by the client for this business.
How to add the Lead Trigger?
This trigger can be added when the client wants to push leads from Birdeye to Entrata. The leads created through referrals aggregate within Birdeye, and integrating this trigger will help push those leads to Entrata.
Trigger Name | Trigger Description |
BirdEye Lead Trigger | This trigger is used to push lead from Birdeye onto CRM |
ADDING LEAD TRIGGER
Log in to your Birdeye account and go to the ‘Settings’ tab on the left navigation rail. On the new screen, go to the ‘Set up Integration’ tab and select the Birdeye Lead Trigger.
These are optional fields which help you filter out leads using ‘Lead Sources’ and ‘Lead Events’ filters.
NOTE: Currently, Birdeye supports ‘Create’ events and ‘Referral’ source leads. These are configured by default and client need to create Lead SourceId for birdeye in entrata if they want to opt for this trigger.
Referral Questions Set - If you want to add the leads in accordance with the response to the question, you can fill in the Referral Questions in this field. For example, ‘When do you need your new apartment? | When are you planning to move in?’ HANDY TIP: In case there are more than one referrals you wish to cover, separate the questions using pipe separators(|).
Possible Error And Resolution at Support End
User doesn't have permission to the property.
This indicates that the intended Trigger doesn’t have permission to access the apis. You need to ask the client to give Read permission to the user for that API. Check the Trigger API reference here(Request Template).