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 only supported for SMB businesses.
NOTE: If there is an enterprise business to be set up and there are unique sign-in required for every location, such integration should be set up as an SMB i.e an integration group should be created for every location.
Integrating Birdeye with Keap (Formerly Infusionsoft)
User Manual - SUPPORT ARTICLE
Keap is a Customer Relationship Management (CRM) tool that helps small businesses track their customers and know key details about them - right down to their last purchase or conversation with the support team. For its customers, keap is a CRM, marketing automation, eCommerce, and payment solution, along with a marketplace of apps - all rolled into one platform.
Birdeye can seamlessly integrate with your keap account and send out review requests to your customers automatically. Once integrated, Birdeye will fetch customer information from keap. This will be done once daily for all the cases that were closed on the previous day. 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
Information required from the Business
Information from Birdeye dashboard
Login
Manage Triggers
Manage Properties
Manage Locations
Integration Requirements
Triggers Supported
Birdeye also allows you to fetch data from your CRM using a predefined trigger. Here is the supported trigger for keap:
Trigger Display Name |
Trigger Name/
Value
| Trigger Description |
Infusionsoft Tagged Customer Trigger Service | Tagged Customer | This trigger is used to fetch customer data based on the specified tag applied. |
Details required from the keap dashboard
Trigger details
Details required from the Birdeye dashboard
Business ID for a single-location account.
Tag Names
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.’
You will find the ‘Business ID’ and ‘API key’ shown in the image.
Integration Process
Before you can integrate keap 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 Infusionsoft CRM in the search bar and select it. Click on ‘Next’.
Manage Triggers
The trigger is automatically selected as only one trigger is supported.
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).
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 Single Location Accounts, select the drop-down 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.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
Tag names: Enter the Tags for which the business wants to send review requests. Use a comma separator for multiple values.
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.
Completing the Integration Process
The below-mentioned steps guide you on how to set up an integration between keap and Birdeye.
To complete the process, click on the 'Settings' tab located on the left navigation rail of your Birdeye dashboard. Click on the ‘Business Profile’ under the ‘Profile’ section.
Click on the specific location for which you have set up the integration.
Once you click on a particular location, it will redirect you to that location. Now, scroll down to the ‘CRM Integrations’, and click on the ‘Authorize Infusionsoft’ button to authorize the business.
You will be asked to log in using your keap credentials. Enter your email and password and click on the ‘Login’ button.
The application will then request you for access to Birdeye. Click on ‘Allow’.
After granting access, you will be redirected to the 'Setup profile' page, where you can see keap as ‘Authorized’ under the CRM integrations header. Birdeye has now been successfully integrated with keap.
Curl Commands
Before you can integrate keap 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 PUThttps://common-services.Birdeye.com/integration/add/businessintegrationgroup -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d '{"parentBusinessNumber" :150088776180458,"integrationSourceId" : 10,"integrationGroupTriggers":[{"triggerId":10,"triggerTypeId":1}]}'150088776180458- Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
10- Integration Trigger ID - Can be one or more triggers. Ask clients what trigger they would like to integrate with, then run the curl command to fetch all possible triggers for keap. Identify the trigger ID (s) and insert (use commas) in case of multiple trigger IDs.
Fetch information for all the triggers available for keap (Curl Command)
Copy this Curl Command:
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/10 -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": 10,
"integrationSourceId": 10,
"triggerService": "keapTaggedCustomerTriggerService",
"displayName": "keap Tagged Customer Trigger",
"description": "This trigger is used to fetch customer data based on the specified tag applied",
"active": true,
"integrationSourceName": "keap",
"integrationTriggerType":[{"id":1,"name":"JOB"}]
}
]10- Trigger ID
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/147983304225680 -H 'Cache-Control: no-cache'
147983304225680- Business ID: Enter the Business ID here to get the integration group details for a business.
Sample Response:
[
{
"groupId": 60,
"integrationSourceType": {
"id": 10,
"integrationSource": "KEAP",
"sourceCategory": "Other",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 10,
"triggerTypeId": 1
}
]
}
]60- 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 a client 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": 60,"integrationGroupTriggers":[{"triggerId":10,"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.
60- Group ID: The Group ID returned in the previous step will be entered here.
10- Trigger ID: Enter the Trigger ID (s) which need to be added or updated to the integration.
Integration Mapping
Once the Integration Group is created, the next step is to create the Integration Mapping.
Copy this Curl Command
curl -X PUT https://common-services.Birdeye.com/integration/add/businessintegrationmapping -H 'Cache-Control: no-cache' -H 'Content-Type: application/json' -d '{"businessNumber": 147983304225680,"active": true,"integrationGroupId" : 60,"integrationProperties" :[{"propertyKey" : "tag_names","propertyValue": "test_Birdeye,test_tag","isSecure" : false}]}'147983304225680- Business ID: Enter the Business ID for the SMB Business.
60- Group ID: Enter the Group ID, which was returned when the Integration group was created.
test_Birdeye,test_tag - Tag names: tag_names property value will be a comma-separated list of tag names associated with customers to whom a review request needs to be sent. Also, ensure that there is no whitespace in the comma-separated list.
Note: tag names should be unique for the customers on the client side. We do not support the same tag names with different tag categories.
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.
Keap Campaign tags are:
tag_id
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 keap are:
Keap tag ID is not in the allowed list
Integration is beta
Description
Keap tag id is different than those present in the allowed list of tag Ids.
The integration setup is currently set to beta.