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 Agentbox
User Manual - SUPPORT ARTICLE
Agentbox is a property management software that caters to the needs of commercial, rural, holiday, business and residential real estate companies. Features including tenant and buyer matching, sophisticated property email alerts, vendor activity reports, staff commissions, and target setting are all part of the software solution's deeply integrated functionality. Additionally, it assists its clients with budget management, financial reporting, contact management, expense management, and billing and invoicing.
Agentbox software helps its clients in Integrating Agentbox with Birdeye will automate the sending of review requests to your customers daily.
Table of Contents
Triggers Supported
Details required from the Agentbox dashboard
Information required from Business
Login
Manage Triggers
Manage Properties
Manage Locations
Restriction Reason
Integration Requirements
Triggers Supported
Birdeye allows you to fetch data from Agentbox 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 Agentbox:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Agentbox Sold properties Trigger | Agentbox Sold Property Trigger | This trigger is used to fetch sold properties. |
Agentbox Leased properties Trigger | Agentbox Leased Property Trigger | This trigger is used to fetch leased properties. |
Details required from the Agentbox dashboard
Trigger Details
Details required from the Birdeye dashboard
Location name
Business ID in case of an SMB Business
Business ID in case of a Multi-location Business
Information from Birdeye Dashboard
For a 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 account - 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 Location ID, hover over the ‘Status’ of location.
Integration Process
Before you can integrate Agentbox 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).
API Key & Client ID: Send the email to the Agentbox support team at support@agentbox.com.au or integration@agentbox.com.au and tag the client in cc to provide the API key and client ID for the particular client. Once the client provides the approval, the Agentbox support team will share the details.
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: 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.
Property Types: The following property types are supported by Birdeye: residential, commercial, rural, holiday, and business. The client can opt for two or more property types amongst the above-mentioned types and can fetch the details by providing a comma-separated list. (By default, all property type details will be fetched).
Office ID: Enter the comma-separated office IDs for which you want to send a review request.
Override Group Properties: With this, you can override the Customer Fetch Delay property 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.
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 ‘Agentbox’ 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 Agentbox 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 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": 226232696,"integrationSourceId": 114,"integrationGroupProperties": [{"propertyKey": "agentbox.client.id","propertyValue": "aHR0cHM6Ly9zYW5kYm94MS5hZ2VudGJveGNybS5jb20uYXUvYWRtaW4v","isSecure": false},{"propertyKey": "agentbox.api.key","propertyValue": "d444-d6a9-51cf-0943-742e-5cbd-9471-eec9-c565-a5b5","isSecure": true},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 125,"triggerTypeId": 1,"actionIds": [1]}]}'226232696- Business ID - This is a Business ID for a single location SMB account
125- 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 Agentbox. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Create Integration Group for Enterprise 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": 226232696,"integrationSourceId": 114,"integrationGroupProperties": [{"propertyKey": "agentbox.client.id","propertyValue": "aHR0cHM6Ly9zYW5kYm94MS5hZ2VudGJveGNybS5jb20uYXUvYWRtaW4v","isSecure": false},{"propertyKey": "agentbox.api.key","propertyValue": "d444-d6a9-51cf-0943-742e-5cbd-9471-eec9-c565-a5b5","isSecure": true},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 125,"triggerTypeId": 1,"actionIds": [1]}]}'226232696- Business ID - This is a Business ID for a single location SMB account
125- 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 Agentbox. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for Agentbox (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/114-H 'cache-control: no-cache' -H 'content-type: application/json'
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/149451644517222 -H 'Cache-Control: no-cache'
Sample Response
13106- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
149451644517222- Business ID: Enter the Business ID here to get the integration group details for a business.
{"groupId": 13106,"integrationSourceType": {"id": 114,"integrationSource": "AGENTBOX","sourceCategory": "Real Estate","integrationType": "Birdeye API","integrationPlan": "Standard","oauthEnabled": true},"integrationGroupTriggers": [{"triggerId": 126,"triggerTypeId": 1,"actionIds": [1]},{"triggerId": 125,"triggerTypeId": 1,"actionIds": [1]}]}13106- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.
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": 13106,"integrationGroupTriggers": [{"triggerId": 125,"triggerTypeId": 1}]}'replaceTriggers=true -To replace existing trigger(s), enter the value for replaceTriggers as true. To add a new trigger(s) to the existing list, the value for replaceTriggers should be false.
13106- Group ID: The Group ID which was returned in the previous step will be entered here.
125- Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Mapping (SMB 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 'Content-Type: application/json' \--data-raw '{"businessNumber": 154746122021310,"integrationGroupId": ,"integrationProperties": [{"propertyKey": "agentbox.property.type","propertyValue": "residential","isSecure": false},{"propertyKey": "agentbox.office.id","propertyValue": "1","isSecure": false},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"active": true,"test": false,"beta": false}'154746122021310- Business ID: Enter the Business ID for the SMB Business.
13106- Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true for enabling the integration.
Integration Mapping (Enterprise Businesses)
Copy this Curl Command
curl --location --request PUT 'https://common-services.birdeye.com/integration/add/businessintegrationmapping' \--header 'Content-Type: application/json' \--data-raw '{"businessNumber": 462887648,"integrationGroupId": ,"integrationProperties": [{"propertyKey": "agentbox.property.type","propertyValue": "residential","isSecure": false},{"propertyKey": "agentbox.office.id","propertyValue": "1","isSecure": false},{"propertyKey": "customer.fetch.delay","propertyValue": "0","isSecure": false}],"active": true,"test": false,"beta": false}'164181194891424-Business ID: Enter the Business ID for the SMB Business.
839-Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.
Residential-Location Name: Enter the Location name as per the name specified in the Agentbox account for the Location picklist corresponding to this business.
Appendix
Restriction Reason and exceptions
Restriction reason is used to identify the contacts which 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 Agentbox 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.