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 VaultRe
User Manual - SUPPORT ARTICLE
VaultRe is a property management software that caters to the needs of both commercial and residential real estate companies. VaultRe software helps its clients in billing and invoicing, expense management, contact management, budget management, and financial reporting. Integrating VaultRe with Birdeye will automate the sending of review requests to your customers daily.
Table of Contents
Information required from the Business
Trigger details
Location name
Business ID for single-location business
Login
Manage Triggers
Manage Properties
Manage Locations
Setup Through Birdeye Dashboard
Restriction Reason
Integration Requirements
Triggers Supported
Birdeye allows you to fetch data from Vaultre 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 VaultRe:
Trigger Display Name | Trigger Name/Value | Trigger Description |
VaultRE Sold properties Trigger | Sold Property | This trigger is used to fetch purchasers' and owners' details associated with Unconditional (sold) property. |
VaultRE Leased properties Trigger | Leased Property | This trigger is used to fetch landlords' and tenants' details associated with leased property |
Details required from the VaultRe dashboard
Trigger Details
Details required from the Birdeye dashboard
Business ID in case of an SMB Business
Information from Birdeye Dashboard
For an SMB account - Business ID.
Login to your Birdeye account, go to the 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.
Steps to create a token
Login to your VaultRE dashboard https://login.vaultre.com.au/.
Click on the ‘Integrations’ tab from the left-hand menu.
Furthermore, click on ‘Third-Party Access.’
On the next screen, you will view all the third-party systems to which you’ve already been granted access. Click ‘Add Token’ in the bottom right of the screen.
From the dropdown, select the ‘Birdeye’ option and click ‘Create Token.’
The access token has now been created; provide this token to your web developer.
NOTE: At any time, you can revoke the developer’s access to your account by clicking ‘Delete’ on this token.
NOTE: If Birdeye is not visible in the third-party dropdown, please raise a ticket at the VaultRe dashboard and cc the office principal.
Integration Process
Before you can integrate VaultRE with Birdeye, you will need to set up the following configurations on the integrations 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 the 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).
Token: The client will provide the token for authorization.
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.
Manage Locations
For SMB Accounts, select the drop-down and click on ‘Add.’
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 status of integration (Active or inactive).
Frequency: It is 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.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Sold Property Types: If the client requires only a particular type of property type details to be fetched, please provide a comma-separated list(By default, all property type details will be fetched).
IMPORTANT: No location-level property is required, and contact will be checked-in for each active location. For details, please refer to this link.
Override Group Properties: With this, you can override the Customer Fetch Delay property added at the group level, specific to each location.
IMPORTANT: If the client has separate token for each location, then they have to use the override group properties to set up tokens at a location level. Otherwise, each location will use a token configured at the group level.
Click on ‘Next’ and click on ‘Save.’
Note: For SMB & Enterprise business: You can use ‘manage the locations’ using this curl command.
Authorize through Integration Dashboard
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 down to the ‘Vaultre’ 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 VaultRE 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 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 is the list of curl commands that 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": 159894423800397,"integrationSourceId": 112,"integrationGroupProperties": [{"propertyKey": "access_token","propertyValue": "9suWS4X9J7daWrKxItqxJIi7ia4QXOHlmnbARrIwzdPwxa+hU5MaPNrwkAOG6Ab3rNorNO7DAWA=","isSecure": true},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 123,"triggerTypeId": 1},{"triggerId": 124,"triggerTypeId": 1}]}'159894423800397- Business ID - This is Business ID for a single location SMB account
123,124- 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 VaultRE. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for VaultRE (Curl Command)
Copy this Curl Command
curl --location --request GET 'https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/112' \--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": 123,"triggerService": "vaultreLeasedPropertyTriggerService","displayName": "Vaultre Leased properties Trigger","description": "This trigger is used to fetch leased properties","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [ 112],"triggerName": "Leased Property","caseTypeId": 1},{"id": 124,"triggerService": "vaultreSoldPropertyTriggerService","displayName": "Vaultre Sold properties Trigger","description": "This trigger is used to fetch sold properties","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [[insert-question 1876096] ],"triggerName": "Sold 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/159894423800397' \--header 'Cache-Control: no-cache'
Sample Response
21338- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
159894423800397- Business ID: Enter the Business ID here to get the integration group details for a business.
{"groupId": 21338,"integrationSourceType": {"id": 112,"integrationSource": "VAULTRE","sourceCategory": "Real Estate","integrationType": "Birdeye API","integrationPlan": "Standard","oauthEnabled": true},"integrationGroupTriggers": [{"triggerId": 123,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 124,"triggerTypeId": 1,"actionIds": []}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": 21338,"integrationGroupTriggers":[{"triggerId":123,"triggerTypeId":1}, {"triggerId":124,"triggerTypeId":1}]}'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.
21338- Group ID: The Group ID which was returned in the previous step will be entered here.
123,124- Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Location Mapping
Integration Mapping (SMB & Enterprise 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 'cache-control: no-cache' \--header 'content-type: application/json' \--data-raw '{"businessNumber": 159894423800397,"integrationGroupId": 21338,"integrationProperties": [{"propertyKey": "vaultre.sold.property.types","propertyValue": "Residential","isSecure": false},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"active": true,"test": false,"beta": false}'159894423800397- Business ID: Enter the Business ID for the SMB Business/ Location of an Enterprise.
21338- Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.
Important Instructions for Email and SMS opt-in/ opt-out.
Log in to the ‘VaultRE’ dashboard. Click on the ‘Contacts’ tab on the left navigation rail.
Click on the ‘Add Contact’ and enter the details such as name, telephone number and email address.
Email opt-out and SMS opt-in
Scroll down to ‘Other’ and check the box against ‘Email’ to opt-out of the email. Click on ‘Save/Update’ to save your preferences.
NOTE: Subscription status is SMS subscribed, which means you have opted for SMS.
SMS opt-in and Email opt-out
Similarly, if you want to opt-in to SMS, check the box against the ‘SMS’ option. Click on ‘Save/Update.’
NOTE: Subscription status is Email subscribed, which means you have opted for email.
Email and SMS opt-out
To opt-out from both ‘Email’ and ‘SMS’, check the boxes below. You will be unsubscribed from both. Click on ‘Save/Update.’
Email and SMS opt-in
If you need to opt-in for email and SMS, do not check the field ‘Email’ and ‘SMS.’ Click on ‘Save/Update.’
Campaigns Tags
Campaign tags are used to set up campaigns within the Birdeye dashboard. These tags are either provided by the client or can be fetched from Kibana for already checked contacts.
VaultRE Campaign tags are:
propertyContactStaffEmails
propertyContactStaffUsernames
NOTE: Contact Staff details (email and username) linked to recent Sold / Leased properties. In case of multiple contact staffs linked to properties, first contact staff details would be added.
How to set up multi-location for VaultRE
For VaultRE multi-location setup, integration mappings would be created for each location, and access tokens would be configured at the group level.
IMPORTANT: No location-level property is required, and contact would be checked-in for each active location.
Separate campaign automation would be set up for each location by selecting only the required location. Campaign tags would be used in the automation filter condition for triggering the campaign for specific contact staff/property agent usernames or emails only.
NOTE: To ensure no duplicate check-in, check with the client that no contact staff is associated with more than one client location.
Appendix
Restriction Reason and exceptions
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. Also, the exceptions can be seen on the integration dashboard or Kibana error logs.
Possible restriction reasons or exceptions for VaultRE are:
Integration is beta
The business has not been authorized; please move to the Birdeye dashboard to authorise the business.
Either Phone or Email should be valid for the creation of a customer Email:null, Phone :null
Description
The integration setup is currently set to beta.
Please Login to the Birdeye dashboard to Authorise the business.
Either the phone number or the email address needs to be added correctly.