Skip to main content

Birdeye Native Integration - RealPage Exchange API

Updated today

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.

Integrating Birdeye with RealPage
User Manual - SUPPORT ARTICLE

RealPage is a comprehensive property management software and analytics tool provider that helps real estate businesses with leasing, renting, management and more. Integrating RealPage with Birdeye will automate the process of sending out review requests to your clients on a daily basis.

Once RealPage is integrated with Birdeye, Birdeye will pull client information from your CRM once daily. 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.

Table of Contents

  1. Integration Requirements

    • Triggers Supported

    • Trigger details

    • Client needs to subscribe RealPage properties to Birdeye app

  2. Details required from the Birdeye dashboard

    • Enterprise ID for multi-location account

    • Business ID in case of a single-location account

  3. SDE Integration Setup

  4. Integration Process

    • Login

    • Manage Triggers

    • Manage Properties

    • Manage Locations

  5. Curl Commands

  6. Migration of FTP Realpage Integrations to Realpage Exchange API Integration

  7. Re-Authorise Business

  8. Restriction Reason

  9. Troubleshooting steps


​

Integration Requirements

Triggers supported

Birdeye allow 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 RealPage:

Trigger Display Name

Trigger Name/Value

Trigger Description

Realpage Exchange Move In Trigger

Move In

This trigger is used to fetch customer data based on move-in to the property.

Realpage Exchange Lease Start Trigger

Lease Begin

This trigger is used to fetch customer data based on the start of the lease period.

Realpage Exchange Prospect Visit Trigger

Prospect Visit

This trigger is used to fetch customer data based on prospect visits to the property.

Realpage Exchange Closed Work Order Trigger

Work Order

This trigger is used to fetch customer data based on completed work orders.

Realpage Exchange Move Out Trigger

Move Out

This trigger is used to fetch move-out residents within a specified date range.


​

Information required from Birdeye Dashboard

  1. 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.
    ​

  2. 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.


​

SDE Integration Setup

To begin, log in to your Realpage OneSite account, for example, https://lkzmanagementllc.onesite.realpage.com/Default.asp.

Fill in your 'Sign-on name’ and 'Password' and click on the 'Sign-on' button.

To start, you need to subscribe your properties to ‘Birdeye’:

  1. Navigate to ‘RealPage Central > Administration > RealPage Exchange > Marketplace’.
    ​

  2. Find ‘Birdeye’ in the list of AppPartners.
    ​

  3. Click on the ‘Select’ next to ‘Birdeye’.

  4. Check the properties you wish to subscribe to.
    ​

  5. Click on the ‘Subscribe to Service’ button.

  6. Complete your contact information in the bottom left corner, then click on the ‘I Accept’ button to accept the Terms of Use.
    ​

The client’s subscription request will now be submitted to the Birdeye team for approval.

NOTES:

  • A user can only manage subscriptions from RealPage Central. You will not be able to subscribe or cancel from the property level.

  • The user submitting the subscription requests must have the ‘Access RealPage Central’ and 'Manage AppPartner Subscriptions' Both of these permissions are located under the Core center. If you do not have this permission, please contact your Super User.

  • For additional assistance, please submit a support ticket from https://www.realpage.com/support/, and choose RealPage Exchange in the product dropdown.

  • Your subscription request will remain in Pending status until Birdeye approves the subscription. You can view the status of your subscriptions at any time by clicking on the number hyperlink under the Selected Properties.

Approve Subscription Request:

Birdeye team will receive an email from Realpage to approve the subsequent subscription request below:

Follow the steps below to approve the above subscription request:

  1. Log in to https://developer.realpage.com/ with the following credentials:-
    ​Username: Birdeye_portal
    ​Password: wxCkfcbCZX

  2. Click on the ‘Manage Integrations’ icon on the left-hand side panel:
    ​

  3. You will see all the subscription requests (pending, active, denied) here; you need to click on the ‘Approve’ button(which will be visible against the specific entry):
    ​

  4. Note the ‘Client ID’ and ‘Site ID’ on this page. Each ‘Site ID’ corresponds to a Birdeye location. This ‘Client ID’ and ‘Site ID’ will be required while setting up the integration.
    ​

Troubleshooting steps:

If you want to raise an issue or seek support from Realpage, log on to the Developer portal and click on the ‘Request Support’ button on the top right of the home page:

On the new screen, you need to fill in the information detailed below:

  1. Priority

    1. P1 - Critical

    2. P2 - High

    3. P3 - Medium

  2. Company – AppPartner Company Name

  3. Contact Name – who should we contact regarding the status of this ticket

  4. Phone – AppPartner contact phone number

  5. Email – AppPartner contact email

  6. Product – choose RealPage Exchange

  7. Check the box for AppPartner/Vendor

  8. Case Type

    1. Question

    2. Issue

    3. Clone - these requests can take up to 5 business days to complete

      • If the request is to extend a current clone/test environment, please include the current clone’s details in the ticket submission.

      • If the clone request is for a client’s specific data, please include the client’s written approval along with the specific property you would like us to clone for you.

      • Indicate the number of days the clone is needed.

      • Include the email the clone should be sent to

  9. Subject

  10. Description - Details of what is missing and what you expect to see.


​

Integration Process

Before you can integrate RealPage 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.

https://integrations.Birdeye.com/sign-in/

Login

  1. After successful login in the integration dashboard, you have to click on ‘BE integration’ and then click on ‘Add Integration.’
    ​

  2. Search for REALPAGEEXCHANGEAPI CRM in the search bar and select it. Click on ‘Next’.
    ​

Manage Triggers

Select the Trigger Name (Check Box) as 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.

  1. Client ID: Client ID can be found while approving subscription requests under Manage Integrations in Realpage developer exchange.

  2. Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).

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.

  1. Status: It shows integration status (Active or Inactive).

  2. Frequency: The number of times integration will sync with CRM (Days or Hours).

  3. Next RunTime: It is the next scheduled time when the integrations will run.

  4. Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).

  5. Site/Property ID: Site ID can be found while approving subscription requests under ‘Manage Integrations' in the Realpage developer exchange.

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:

  1. For SMB: You can use ‘manage the locations’ using this curl command.

  2. For Enterprise: You can use ‘manage the locations’ using this curl command.


​

Authorize through Integration Dashboard

To set up through Integration Dashboard, follow these steps:

Once in the Integration dashboard, click on the ‘BE Integrations’ tab on the left navigation rail. Search for RealPage Exchange API and hover over the three dots and click on ‘Edit.’

Once you click on the edit option, a screen will appear. Scroll down to ‘Locations’ to authorize the location.

Hover over three dots, and click the ‘Actions’ drop-down button.

Furthermore, click on the ‘Authorize’ button.

After clicking the authorize option, the location will be authorized.


​

Curl Commands

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 --location --request PUT 'https://qacs.birdeye.com/integration/add/businessintegrationgroup' \--header 'Cache-Control: no-cache' \--header 'Content-Type: application/json' \--data-raw '{"parentBusinessNumber": 153027269604508,"integrationSourceId": 69,"integrationGroupProperties": [{"propertyKey": "realpage.exchange.pmcid","propertyValue": "4604057"}],"integrationGroupTriggers": [{"triggerId": 93,"triggerTypeId": 1},{"triggerId": 94,"triggerTypeId": 1},{"triggerId": 95,"triggerTypeId": 1},{"triggerId": 96,"triggerTypeId": 1},{"triggerId": 122,"triggerTypeId": 1}]}'

  • 153027269604508-Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account

  • 93, 94, 95,96,122 - Integration Trigger ID - Can be one or more triggers. Ask the business what trigger they would like to integrate with, and then run the curl command below to fetch all possible triggers for RealPage. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs

  • 4604057 - Realpage Client ID: Client ID can be found while approving subscription requests under Manage Integrations in Realpage developer exchange.

Fetch information for all the triggers available for RealPage (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/69 -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": 93,"triggerService": "realPageExchangeLeaseStartTriggerService","displayName": "Realpage Exchange Lease Start Trigger","description": "This trigger is used to fetch customer data based on the lease start date.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [69],"triggerName": "Lease Start","caseTypeId": 1},{"id": 122,"triggerService": "realPageExchangeMoveOutTriggerService","displayName": "Realpage Exchange Move Out Trigger","description": "This trigger is used to fetch Move Out Residents within specified date range","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [69],"triggerName": "Move Out","caseTypeId": 1},{"id": 94,"triggerService": "realPageExchangeProspectVisitTriggerService","displayName": "Realpage Exchange Prospect Visit Trigger","description": "This trigger is used to fetch customer data based on the prospect visit to the property.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [69],"triggerName": "Prospect Visit","caseTypeId": 1},{"id": 96,"triggerService": "realPageExchangeClosedWorkOrdersTriggerService","displayName": "Realpage Exchange Closed Work Order Trigger","description": "This trigger is used to fetch customer data based on completed work orders.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [69],"triggerName": "Work Order","caseTypeId": 1},{"id": 95,"triggerService": "realPageExchangeMoveInTriggerService","displayName": "Realpage Exchange Move In Trigger","description": "This trigger is used to fetch customer data based on the move in to the property.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [69],"triggerName": "Move In","caseTypeId": 1}]

  • 93, 94, 95, 96 & 122 - Trigger IDs

Find business integration group details (Curl Command)

Copy this Curl Command

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

  • 155923642624132 - Business ID: Enter the Business ID here to get the integration group ID for the business.

Sample Response:

[{"groupId": 12814,"integrationSourceType": {"id": 69,"integrationSource": "REALPAGEEXCHANGEAPI","sourceCategory": "Real Estate","integrationType": "Birdeye API","integrationPlan": "Basic","oauthEnabled": false},"integrationGroupTriggers": [{"triggerId": 94,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 95,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 96,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 93,"triggerTypeId": 1,"actionIds": [1]}]}]

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

Update Trigger Information (use only if a business wants to 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": 12814,"integrationGroupTriggers":[{"triggerId":93,"triggerTypeId":1}]}'

  • replaceTriggers=true - To replace existing trigger(s), enter the value for replaceTriggers as To add a new trigger(s) to the existing list, the value for replaceTriggers should be false

  • 12814 - The Group ID that was returned in the previous step will be entered here.

  • 93- Enter the Trigger ID(s) that need to be added or updated to the integration.

Business Integration Mapping:

Copy this Curl Command

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

curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{"businessNumber":155932464844756,"integrationGroupId":12814,"active":true,"integrationProperties":[{"propertyKey":"realpage.exchange.siteid","propertyValue":"4604065"}]}'

  • 155932464844756 - Business ID- Enter the Business ID here.

  • 12814 - Group ID- Enter the Group ID that was returned when the Integration group was created.

  • 4604065 - Property Site ID - Site ID can be found while approving subscription requests under ‘Manage Integrations' in the Realpage developer exchange.

NOTE: If more than one property is mapped to a single business in Birdeye, replace the property value in the curl command by listing property values separated by a comma.


​

Migration of FTP Realpage Integrations to Realpage Exchange API Integration:

  1. Follow all the steps in the SDE Integration Setup Page here

  2. Use the following Curl command to migrate any business integration:

curl --location --request GET 'https://common-services.Birdeye.com/realpage/migrateBusinessIntegration?businessNumbers=155911946802764&clientID=4604057'

  • 155911946802764 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account

  • 4604057 - Realpage Client ID: Client ID can be found while approving subscription requests under ‘Manage Integrations’ in Realpage developer exchange.


​

Re-Authorise Business

Sometimes it happens the credentials entered were wrong during setup or are 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.

Re-Authorise Document


​

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 RealPage Exchange API are:

  1. The relationship code is not valid

  2. Integration is beta

Description

The customer is not the head of the household.


​

Troubleshooting steps

If you encounter any of the above restriction reasons, please search the following keys to know the reason for restricting the contact.

  1. Relationship code is not valid
    Please look up the key Relationship Code on kibana to know the value of the relationship code

  2. Integration is beta
    Please look up the key beta in kibana to know whether the integration is beta or not.

Related Articles
BirdEye Native Integration - CDK Global
BirdEye Native Integration - RealPage
Birdeye Native Integration - MYOB
Birdeye Native Integration - Eaglesoftware
BirdEye Native Integration - Lightspeed
Did this answer your question?