*This integration is supported for both SMB & Enterprise businesses.

Integrating BirdEye with Lightspeed
User Manual

Introduction

Integration Requirements

Triggers Supported

Information required from the Business

Required Permission
Lightspeed Shop ID (In the case of Enterprise account)
Work Order Status [Should be provided by the client exactly as it is, during the initial setup if it needs to be filtered under ‘Work Order Status’. If not provided, the default Work Order Status will be used by BirdEye.(Done & Paid)]

Information from BirdEye dashboard

Enterprise ID for multi-location account and Business ID for all locations.
Business ID in the case of an SMB business

Integration Process

Business Integration Group

Create Integration Group (Curl Command)
Fetch information for all the triggers (Curl Command)
Find business integration group details (Curl Command)
Update Trigger Information (Curl Command)

Integration Mapping

Integration Mapping

Integration Process on BirdEye Dashboard

Introduction

Lightspeed is a point of sale and e-commerce solution used by restaurant owners and retailers. Lightspeed offers features such as inventory and customer management, process transactions, and store analytics. Integrating Lightspeed with BirdEye will automate the process of sending out review requests to clients on a daily basis.

Once the integration between Lightspeed and BirdEye is successful, BirdEye will pull client information from Lightspeed once daily from 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.

Integration Requirements:

Triggers Supported

BirdEye allows you to fetch data from your CRM using a predefined trigger. Here is the supported trigger for Lightspeed:

Trigger Name	Trigger Description
Lightspeed Sales Trigger	This trigger is used to fetch customer data based on the sales data.
Lightspeed Work Order Trigger	This trigger is used to fetch customer data based on the work order status.

Details required from the BirdEye dashboard

Enterprise ID for 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
For multi-location account - Enterprise ID and Business IDs of all locations

Enterprise ID

Business IDs of all locations

Integration process

Before you can integrate Lightspeed with BirdEye, you will need to set up the following configurations:

Business Integration Group: 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.
Note :
1. Sales Trigger will fetch the completed Sales data.
2. Work Order Status : We can fetch available work order status list for account by using following curl :

CURL Command :

curl --location --request GET 'https://api.lightspeedapp.com/API/Account/117564/WorkorderStatus.json' \
--header 'Authorization: Bearer 05179398d6d7241812af2b7f6ddeade9d47074bc'117564 : Account ID

(a) Create Integration Group (Curl Command)

Copy this Curl Command

curl --location --request PUT 'https://common-services.birdeye.com/integration/add/businessintegrationgroup' \
--header 'content-type: application/json' \
--data-raw '{
"integrationGroupTriggers": [
{
"actionIds": [
1
],
"triggerId": 85,
"triggerTypeId": 1
},
{
"actionIds": [
1
],
"triggerId": 88,
"triggerTypeId": 1
}
],
"integrationSourceId": 60,
"parentBusinessNumber": 157322822486773}'

155379496870319 - Business ID - This is Enterprise ID for multi-location account and Business ID for a single location SMB account
85,88- Integration Trigger ID - Ask client what trigger they would like to integrate with then run the curl command to fetch all possible triggers for Lightspeed. Identify the trigger ID(s) and insert (use commas) in case of multiple trigger IDs.

(b) Fetch information for all the triggers available for Lightspeed (Curl Command)

Copy this Curl Command

CURL COMMAND:

curl -X GET https://common-services.birdeye.com/integration/trigger/integrationtriggers/sourceid/60 -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 the ID. This trigger ID will be utilized while creating the integration group. An integration can have one or more triggers. To use more than one trigger, enter comma separated values while creating the integration group.

[
{
"id": 85,
"triggerService": "lightSpeedSalesTriggerService",
"displayName": "Lightspeed Sales Trigger Service",
"description": "This trigger is used to fetch customer data based on the sales.",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
60
],
"triggerName" : "Sales"
},
 {
"id": 88,
"triggerService": "lightSpeedWorkOrderTriggerService",
"displayName": "Lightspeed Work Order Trigger Service",
"description": "This trigger is used to fetch customer data based on the work order status.",
"active": true,
"integrationTriggerType": {
"id": 1,
"name": "JOB"
},
"caseCreationTriggerType": {
"id": 1,
"name": "JOB"
},
"actionGroupId": 1,
"sourceIdsList": [
60
],
"triggerName" : "Work Order"
}
]

85,88 - Trigger ID

(c) Find business integration group details (Curl Command)

Copy this Curl Command

curl -X GET https://common-services.birdeye.com/integration/businessintegrationgroup/155379496870319 -H 'Cache-Control: no-cache'
[
{
"groupId": 10716,
"integrationSourceType": {
"id": 60,
"integrationSource": "LIGHTSPEED",
"sourceCategory": "Retailing",
"integrationType": "Birdeye API",
"integrationPlan": "Basic",
"oauthEnabled": true
},
"integrationGroupTriggers": [
{
"triggerId": 85,
"triggerTypeId": 1,
"actionIds": [
1
]
}
]
}
]

155379496870319 - Business ID: Enter the Business ID here to get the integration group details for a business.

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

(d) 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": 10716,"integrationGroupTriggers":[{"triggerId":85,"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.
10716- The Group ID which was returned in the previous step will be entered here.
85-Enter the Trigger ID (s) which need to be added or updated to the integration.

2. Integration Mapping:

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": 154343768129091,
"integrationGroupId": 10716,
"active": true,
"integrationProperties":
[
{
"propertyKey" :"shopID",
"propertyValue" :"6"
}
]
 }'

10716 - Group ID: Enter the Group ID which was returned when the Integration group was created.
6 - ShopID:Mandatory for multi location.We can find shopID using below steps:
- Login to LightSpeed Web Portal
- Navigate to Settings>Shops>{Respective Shop}
- Edit the URL in Browser and find the ID. It should look like
  https://us.lightspeedapp.com/choose_register.php?form_name=change_shops&shop_id=4

Here shop_id represents shopID.

Note : This URL appears for a short time in the URL tab. Please check the URL tab just after clicking on shop.

Completing the Integration Process

After the initial integration is set up by the BirdEye technical support team, you need to log in to your BirdEye account to complete the rest of the integration process.

To complete the process, click on the 'Settings' tab located on the left navigation rail of your BirdEye dashboard. On the bottom of the 'Settings' page, click on the 'Authorize Lightspeed' button under the CRM integrations header.

After you click on the authorization button, you will be redirected to the Lightspeed website. Enter the username and password associated with your Lightspeed and click on the 'Sign In' button.

Once you have signed in to your Lightspeed account, BirdEye will ask for certain permissions to obtain patient data from your Lightspeed account. Click on the 'Authorize' button at the bottom to complete the integration process.

After the access has been granted, you will be redirected to the BirdEye dashboard and an ‘Authorized' message will appear right next to Lightspeed.

Restriction Reason

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.

Possible restriction reasons for Lightspeed are: