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 Authenticom
User Manual - SUPPORT ARTICLE
https://www.authenticom.com/Authenticom is a Dealer Management Systems (DMS) integration and Data Enhancement Solutions used by the automotive industry. Authenticom provides back-end support for automotive marketing agencies, CRM systems, and third-party service providers. It integrates with over 75 DMS, including Reynolds & Reynolds, DealerTrack, and ADP. Integrating Authenticom with Birdeye will provide a bridge to fetch customer data from over 75 DMS used by Birdeye clients.
Once Authenticom is integrated with Birdeye, Birdeye will pull client information from Authenticom based on the sales and service files received at the SFTP site. 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 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 Authenticom:
Trigger Display Name | Trigger Name/Value | Trigger Description |
Authenticom Sales Trigger | Sales | This trigger is used to fetch customer data based on the sales files received at the DealerVault SFTP site. |
Authenticom Service Trigger | Service | This trigger is used to fetch customer data based on the service files received at the DealerVault SFTP site. |
Details required from the Authenticom dashboard
Trigger Details
Details required from the Birdeye dashboard
Enterprise Id for a multi-location account and Business Id for all locations.
Business Id in case of an SMB Business.
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.
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.
How to request a new feed
Follow the steps below to request a new feed.
Login into the Dealervault vendor portal and click on ‘New feed request’ from the ‘Orders dropdown’ menu.
Select the order type and click on the ‘Continue’ button.
NOTE:To add a single dealership, click on the ‘Add a new Dealership’ option. For adding multiple dealerships, upload a list of new dealerships by clicking on that option.
Select the program ‘BirdEye Inc’ by clicking on the Vendor program dropdown button. Furthermore, enter your details such as full name, e-mail address and phone number.
NOTE:Details of the person who is creating the feed request.
Now, provide all the details of the Dealership i.e. the Client. In the Dealership Contact Information, enter the details of the person who will approve the request.
After that, confirm the location by clicking on the ‘Next’ button.
After submitting the ticket, Authenticom will ask the client to approve the new feed request created by Birdeye to share the feed from the client’s sales and service. Once approved by the POC of the client then, Birdeye will start receiving the feed.
Troubleshooting Steps:
Checking Authenticom SFTP folder; when was the last time we received sales/service feed files.
To check the service and sales file files in WinSCP or Filezilla:
FTP Site: ftp.dealervault.com
AuthenticomUsername: DVV01101
Password: 39L7027bValidating with a business if they have sales and services completed recently.
Validating with Authenticom why we have not received feeds for said sales and services as per the client.
Integration Process
Before you can integrate Authenticom 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 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).
No. of days before which feed data would be excluded in the first feed: When a job is run for the first time, then last.fetch.date is null. In that case, last.fetch.date is set/saved to the current date - this property value. For example, if the current date is September 16 and prop = 15 days, then last.fetch.date = September 1.
Skip restriction finalized date: Select true to skip the restriction logic based on the final date. Otherwise, no review request is sent if a final date is earlier than the last retrieved date.
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 (without historical data), curl command (with historical data).
For Enterprise accounts, you can access the curl command (without historical data), curl command (with historical).
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 is when the integrations will run.
Customer fetch delay: It is used if businesses want to send review requests with a delay (number of days).
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 you can integrate Authenticom 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 without customization of historical data (Curl Command)
Copy this Curl Command
curl --location --request PUT 'https://common-services.birdeye.com/integration/add/businessintegrationgroup' \
--header 'content-type: application/json' \
--header 'cache-control: no-cache' \
--data-raw '{
"parentBusinessNumber": 82134817484848,
"integrationSourceId": 1,
"integrationGroupTriggers": [
{
"triggerId": 35,
"triggerTypeId": 1
},
{
"triggerId": 36,
"triggerTypeId": 1
}
]
}'82134817484848 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
35 & 36 - 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 Authenticom. Identify the trigger Id (s) and insert (use commas) in case of multiple trigger Ids.
Create Integration Group with customization of historical data (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" : 8274874847847847, "integrationSourceId" : 1,"integrationGroupTriggers":[{"triggerId":16,"triggerTypeId":1}],
"integrationGroupProperties" :[{"propertyKey" :"sftp.feed.first.run.historical.days.allowed", "propertyValue" : 15} ] }'82134817484848 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
16 - 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 Authenticom. Identify the trigger Id (s) and insert (use commas) in case of multiple trigger Ids.
15 - Number Of Historic Days Allowed For The First Run: By default, for the very first feed file processing, Birdeye will only allow records that are up to 15 days old. If you want to allow records for a different period, replace this value with the number of days required.
Fetch information for all the triggers available for Authenticom (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/1 -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": 35,
"triggerService": "authenticomSalesTriggerService",
"displayName": "Authenticom Sales Trigger",
"description": "This trigger is used to fetch customer data based on sales files received at DealerVault SFTP site",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
1
],
"triggerName": "Sales",
"caseTypeId": 1
},
{
"id": 36,
"triggerService": "authenticomServiceTriggerService",
"displayName": "Authenticom Service Trigger",
"description": "This trigger is used to fetch customer data based on service files received at DealerVault SFTP site",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
1
],
"triggerName": "Service",
"caseTypeId": 1
}
]35 - Trigger ID
Update triggers in Integration Group (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":15,"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.
14 - The Group Id returned in the previous step will be entered here.
15 - Enter the Trigger Id (s) which need to be added or updated to the integration.
Find business integration group details (Curl Command)
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/businessintegrationgroup/151665576851626 -H 'Cache-Control: no-cache'
151665576851626 - Business ID: Enter the Business Id here to get the integration group details for a business.
Sample Response:
[
{
"groupId": 6,
"integrationSourceType": {
"id": 1,
"integrationSource": "AUTHENTICOM",
"sourceCategory": "Automotive",
"integrationType": "3rd Party - Authenticom",
"integrationPlan": "Premium",
"oauthEnabled": false
},
"integrationGroupTriggers": [
{
"triggerId": 35,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
}
]6 - Group ID: A group Id will be returned in the sample response with the details of the existing triggers for a business.
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": <business_number>, "integrationGroupId" : <integration_group_id>, "active": true }'<business_number>- Business Number: Enter the Business number here.
<integration_group_id>- Integration Group ID: Enter the Integration Group Id, which was returned when the Integration group was created.
true - Active: Set “true” if you want to enable the integration, else, set “false”.
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 checkedIn contacts.
Authenticom Campaign tags are:
pms
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 Authenticom are:
Finalized date in the file is less than the last saved fetch date
The finalized date is blank
Integration is beta
Description
Finalized date fetched from the feed is less than the last fetch date.
Finalized date is blank fetched from feed/file is blank.
The integration setup is currently set to 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.
Finalized date in the file is less than the last saved fetch date
Please look up the key finalized_date on kibana to know the value of finalized date and compare it with last.fetched.date.Finalized date is blank
Finalized date will not be present on kibana.Integration is beta
Please look up the key beta in kibana to know whether the integration is beta or not.