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 SiteLink
User Manual - SUPPORT ARTICLE
SiteLink is a self-storage and property management software generally used by self-storage owners and property managers to manage the accounting and administrative side of their businesses. SiteLink helps its clients in tenant and lease tracking, property accounting, budgeting, and forecasting.
Table of Contents
Triggers Supported
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers supported
The 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 SiteLink:
Trigger Display Name | Trigger Name/ Value | Trigger Description |
SiteLink Move In Trigger | MOVE_IN | This trigger is used to fetch customer data based on move-in to the property |
SiteLink Move Out Trigger | MOVE_OUT | This trigger is used to fetch customer data based on move-out from the property |
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.
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 a location.
Integration process
Before you can integrate SiteLink 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 SiteLink 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.
Sitelink Corporate Username, Sitelink Corporate Code and Sitelink Corporate Password: This will be shared by the customer during the initial call.
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.
Status: It shows 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 integrations will run.
Sitelink Location Code: This will be shared by the customer during the initial call.
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.
For Enterprise: You can use ‘manage the locations’ using this curl command.
Curl Commands
Before integrating SiteLink 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 PUT https://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "parentBusinessNumber" :150088776180458, "integrationSourceId" : 23, "integrationGroupTriggers":[{"triggerId":37,"triggerTypeId":1}], "integrationGroupProperties" :[ { "propertyKey" :"sitelink.corporate.code", "propertyValue" :"CCTST" }, { "propertyKey" :"sitelink.corporate.username", "propertyValue" : "Administrator" }, { "propertyKey" :"sitelink.corporate.password", "propertyValue" : "Demo", "isSecure" : true } ] }'150088776180458 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
37 - 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.
Administrator - corporate.username - Will be shared by the customer on the initial setup call.
Demo - corporate.password- Will be shared by the customer on the initial setup call.
CCTST-corporate.code- Will be shared by the customer on the initial setup call.
NOTE: We will get the Group ID once we run the first curl (Integration Group) and make a note of the group ID as that will be required while we are doing the integration mapping.
Fetch information for all the triggers available for SiteLink (Curl Command)
Copy this Curl Command
curl -X GEThttps://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/23 -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 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": 37,"integrationSourceId": 23,"triggerService": "siteLinkMoveInTriggerService","displayName": "SiteLink Move In Trigger","description": "This trigger is used to fetch customer data based on move-in to the property","active": true,"integrationSourceName": "SiteLink","integrationTriggerType":[{"id":1,"name":"JOB"}]},{"id": 38,"integrationSourceId": 23,"triggerService": "siteLinkMoveOutTriggerService","displayName": "SiteLink Move Out Trigger","description": "This trigger is used to fetch customer data based on move-out from the property","active": true,"integrationSourceName": "SiteLink","integrationTriggerType":[{"id":1,"name":"JOB"}]}]37 and 38 - Trigger ID
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/150835066887293 -H 'Cache-Control: no-cache'
150835066887293 - Business ID: Enter the Business ID here to get the integration group details for the business.
Sample Response
[{"groupId":166,"integrationSourceType":{"id":23,"integrationSource":"SITELINK","sourceCategory":"Real Estate","oauthEnabled":false}, "integrationGroupTriggers": [{"triggerId": 37,"triggerTypeId": 1}]}]166 - 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 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": 14,"integrationGroupTriggers":[{"triggerId":37,"triggerTypeId":1},{"triggerId":38,"triggerTypeId":1}]}'
replaceTriggers=true - To replace existing trigger(s), enter the value for replaceTriggers as To add new trigger(s) to the existing list, the value for replaceTriggers should be false
14 - The Group ID that was returned in the previous step will be entered here.
37 and 38 - Enter the Trigger ID(s) that need to be added or updated to the integration.
Integration Mapping
This configuration is developed to create the actual business integration mapping. Each business integration mapping corresponds to an individual business location.
Copy this Curl Command
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'accept: application/json' -H 'cache-control: no-cache' -H 'content-type: application/json' -d '{ "businessNumber": 150088776180458, "integrationGroupId" : 13, "active": true, "integrationProperties":[ { "propertyKey" :"sitelink.location.code", "propertyValue" :"Demo" }] } '150088776180458 - Business ID- Enter the Business ID here.
13 - Group ID- Enter the Group ID that was returned when the Integration group was created.
Demo - sitelink.location.code: Will be shared by the customer on the initial setup call.
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 SiteLink are:
Integration is beta
Description
The integration setup is currently set to beta.