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 SMB only

Integrating Birdeye with Clover
User Manual - SUPPORT ARTICLE

Clover is the fastest-growing POS platform backed by Fiserv, a market leader processing over 50% of global card transactions. It currently operates in the United States, United Kingdom, Ireland, Germany, Austria, Canada, and Argentina and expands to new regions to better serve merchants around the globe. At Clover, they design and build low-cost and highly functional Android-based point-of-sale (POS) systems for small or medium-sized businesses (SMBs). Clover merchants use our suite of apps for different business functions. Clover is an open platform allowing third-party developers to build apps and integrate external POS systems with Clover devices.

Once Clover is integrated with Birdeye, information will be pulled from Clover once every day from the list of orders marked as paid from the previous day. Birdeye collects your client's first name, last name, email address and phone number and automatically sends them review requests based on the preferences set within the Birdeye dashboard.

INTEGRATION PREREQUISITE: As a prerequisite to set up the integration with Clover, an email needs to be sent to developer-relations@devrel.clover.com by the support team, post which the Clover API team will add the Birdeye app to the provided merchant ID. The support team needs to send this setup request (Request Template). Only after the business’ permission and getting the merchant ID from the clover dashboard.

Table of Contents

Integration Requirements
Details required from the Business
- Trigger details
- Merchant ID
Details required from the Birdeye dashboard
- Location name
- Business ID for single-location business
Integration Process
- Login
- Manage Triggers
- Manage Properties
- Manage Locations
Completing the Integration Process
- Setup Through Birdeye Dashboard
Curl Command
Appendix
- Restriction Reason

Integration Requirements

Triggers Supported

Birdeye allows you to fetch data from your PMS using a predefined trigger. You can choose the available trigger and inform the support team. Here is the supported trigger for Clover:

Trigger Display Name	Trigger Name/Value	Trigger Description
Clover Paid Orders Trigger	Paid Order	This trigger is used to fetch customer data based on the paid order transactions.

Details required from the Clover dashboard

Trigger Details
Merchant ID

Details required from the Birdeye dashboard

Location Name
Business ID in case of an SMB Business
Authorization from Birdeye dashboard

Information from Birdeye Dashboard

For an 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.’

The ‘Business ID’ and ‘API key’ are 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.

Integration Process

Before you can integrate Clover 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.

https://integrations.Birdeye.com/sign-in/

After successful login in the integration dashboard, you have to click on ‘BE integration’ and then click on ‘Add Integration.’
Search for Clover 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.

Manage Properties

Here; you can manage group-level properties, which will be applied to all locations under a CRM.

Merchant ID: It is the merchant ID of the Clover business.

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/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 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: The user can override the below-mentioned property for a particular 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

Setup through Birdeye Dashboard

The rest of the setup is to be completed within the business’ Birdeye dashboard:

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 Clover’ button to authorize the business.

After you click on the authorization button, you will be redirected to the Clover website. Enter the email address and password associated with your Clover account and Click on ‘Sign in.’

Once you have signed in to your Clover account, Birdeye will ask for permission to obtain client data from your Clover account. Click on the ‘Allow Access’ button at the bottom to complete the integration process.

After the access is granted, you will be redirected to the Birdeye dashboard, and an 'Authorized' message will appear next to Clover.

Fetch Merchant ID

Merchant ID: Click on ‘Help’ at the top of the Dashboard, or

When you log in to your merchant dashboard, click ‘Account & Setup’> ‘Merchants’ to view your Merchant ID number under the MID column.

Your merchant ID will be the 13-character ID in the page URL.

Curl Commands

Before you can integrate Clover 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.

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 -X PUT'https://common-services.Birdeye.com/integration/add/businessintegrationgroup' \--header 'Content-Type: application/json' \--data-raw '{"parentBusinessNumber": 164181194891424,"integrationSourceId": 109,"integrationGroupProperties": [{"propertyKey": "merchantId","propertyValue": "XYZXCDF","isSecure": false}],"integrationGroupTriggers": [{"triggerId": 118,"triggerTypeId": 1,"actionIds": [1]}]}'

164181194891424- Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
118- 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 Clio. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.
XYZXCDF- Merchant ID - This ID will be provided by the customer.

Fetch information for all the triggers available for Clover (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/109-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": 118,"triggerService": "cloverPaidOrdersTriggerService","displayName": "Clover Paid Orders Trigger","description": "This trigger is used to fetch customer data based on the paid order transactions.","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [109],"triggerName": "Paid Order"}]

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'● 149451644517222- Business ID: Enter the Business ID here to get the integration group details for a business.[{"groupId": 19963,"integrationSourceType": {"id": 109,"integrationSource": "CLOVER","sourceCategory": "Legal","integrationType": "Birdeye API","integrationPlan": "Basic","oauthEnabled": true},"integrationGroupTriggers": [{"triggerId": 118,"triggerTypeId": 1,"actionIds": [1]}]}]

3- Group ID: A group ID will be returned in the sample response with the details of the existing triggers for a business.

Integration Location Mapping

Integration Mapping (SMB Businesses)

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": 149451644517222, "integrationGroupId" : 11, "active": true }'

149451644517222- Business ID: Enter the Business ID for the SMB Business.
11- Group ID: Enter the Group ID, which was returned when the Integration group was created.
true - Active: Enter true to enable the integration.

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 Clover are: