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 Self Storage Manager
User Manual - SUPPORT ARTICLE
Self Storage Manager is customer management software. It is a well-suited user-friendly solution that benefits single and multi-facility operators. It renders a technology solution and cloud access control tools to assist in effective management and streamline business processes. It enhances ROI and improves customer service. Integrating Self Storage Manager with Birdeye will automate the process of sending out review requests to your clients on a daily basis.
Once Self Storage Manager 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
Triggers Supported
Trigger details
Client needs to subscribe Self Storage Manager properties to Birdeye app
Enterprise ID for multi-location account
Business ID in case of a single-location account
Login
Manage Triggers
Manage Properties
Manage Locations
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 Self Storage Manager:
Trigger Display Name | Trigger Name/ Value | Trigger Description |
SSM Move In Trigger | SSM Move In Trigger | This trigger is used to fetch Move In tenants within a specified date range |
SSM Move Out Trigger | SSM Move Out Trigger | This trigger is used to fetch Move Out tenants within specified date range |
Information required 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.
Steps to onboarding a new client
When a new client will onboard with Birdeye, you need to email Self Storage Manager Support (john@selfstoragemanager.com) with our mutual client's name.
Once these details are shared, the Self Storage Manager team will set up the Production API credentials for the right company.
Integration Process
Before you can integrate Self Storage Manager 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 Self Storage ManagerEXCHANGEAPI 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.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
SSM Customer Code: Enter the SSM customer code provided by SSM.
SSM Customer Password: Enter the SSM customer password provided by SSM.
SSM Company ID: Unique identifier provided by SSM for Company API. e.g. For SSM API url
https://www.ssm19.selfstoragemanager.net/StorageStarBirdeyeAPI/service.asmx shared by SSM, Company ID is the highlighted part i.e. StorageStarBirdeyeAPI.
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: The next scheduled time when the integrations will run.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
SSM Location Code: Enter the location or facility code that requires customer check-ins.
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
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://common-services.Birdeye.com/integration/add/businessintegrationgroup' \--header 'cache-control: no-cache' \--header 'content-type: application/json' \--data-raw '{"parentBusinessNumber": 155802718182498,"integrationSourceId": 122,"integrationGroupProperties": [{"propertyKey": "ssm.customer.code","propertyValue": "BirdeyeIntegration","isSecure": false},{"propertyKey": "ssm.customer.password","propertyValue": "12345678","isSecure": true},{"propertyKey": "ssm.company.api.name","propertyValue": "BirdeyeAPI","isSecure": false},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 135,"triggerTypeId": 1},{"triggerId": 136,"triggerTypeId": 1}]}'155802718182498-Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
135,136- 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 Self Storage Manager. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for Self Storage Manager (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/122' \--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": 135,"triggerService": "SSMMoveInTriggerService","displayName": "SSM Move In Trigger","description": "This trigger is used to fetch Move In tenants within specified date range","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [122],"triggerName": "SSM Move In Trigger","caseTypeId": 1},{"id": 136,"triggerService": "SSMMoveOutTriggerService","displayName": "SSM Move Out Trigger","description": "This trigger is used to fetch Move Out tenants within specified date range","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [122],"triggerName": "SSM Move Out Trigger","caseTypeId": 1}]135,136- Trigger IDs
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'
155802718182498- Business ID: Enter the Business ID here to get the integration group ID for the business.
Sample Response:
{"groupId": 23374,"integrationSourceType": {"id": 122,"integrationSource": "SSM","sourceCategory": "Real Estate","integrationType": "Birdeye API","integrationPlan": "Standard","oauthEnabled": false},"integrationGroupTriggers": [{"triggerId": 135,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 136,"triggerTypeId": 1,"actionIds": [1]}]},23374-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 --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": 23374,"integrationGroupTriggers": [{"triggerId": 135,"triggerTypeId": 1},{"triggerId": 136,"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
23374- The Group ID that was returned in the previous step will be entered here.
135,136- 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 --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": 23374,"integrationGroupTriggers": [{"triggerId": 135,"triggerTypeId": 1},{"triggerId": 136,"triggerTypeId": 1}]}'155932464844756 - Business ID- Enter the Business ID here.
12814 - Group ID- Enter the Group ID that was returned when the Integration group was created.
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.
Important Instructions for SMS opt-in/ opt-out.
To opt in for SMS
Login to the Self Storage Manager dashboard and click on ‘Rent/Reserve.’ After selecting the unit for Move-in, scroll down to the ‘Tenant Information’ section and at the bottom right, check the field of ‘Send SMS Reminders’ to opt-in for SMS.
However, do not check the ‘Send SMS Reminders’ field if you want to opt out of SMS.
NOTE: We do not have the option to opt out of Email. By default, it is always true.
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 Self Storage Manager are:
Tenant is already moved out in case of Move In trigger only.
Customer is inactive.
Phone or Email should be valid for creating a customer Email: null, Phone: null.
Integration is beta.
Description:
Tenant is already moved out in case of Move In trigger only.
Customer is inactive.
Phone or Email should be valid for creating a customer Email: null, Phone: null.
Integration is beta.
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.Either Phone or Email should be valid for the creation of a customer. Email: null, Phone: null.
Check the email address and phone number.Integration is beta.
Please look up the key beta in kibana to know whether the integration is beta or not.