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.
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 Lightspeed
User Manual - SUPPORT ARTICLE
Lightspeed Retail (X-Series) is a point-of-sale and e-commerce solution used by retailers. Lightspeed Retail (X-Series) offers features such as inventory and customer management, process transactions, and store analytics. Integrating Lightspeed Retail (X-Series) with Birdeye will automate the process of sending out review requests to clients on a daily basis.
Once the integration between Lightspeed Retail (X-Series) and Birdeye is successful, Birdeye will pull client information from Lightspeed Retail (X-Series) once daily from the cases 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
Outlet ID
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 a predefined trigger. Here is the supported trigger for LightspeedXSeries:
Trigger Display Name | Trigger Name/ Value | Trigger Description |
LightspeedXSeriesSalesTriggerService | LightspeedXSeries Sales Trigger Service | This trigger is used to fetch customer details. |
Information required from the Business
Required Permission
Lightspeed Retail (X-Series) Outlet ID (In the case of Enterprise account)
How to fetch outlet id(customer) steps
Click on the ‘Setup’ option after logging into the client’s retail account.
Select the ‘Outlets and Registers’ tab to get a multi-location Outlet ID.
Select the outlet for which you want the Outlet Id. You can fetch the Outlet Id from the URL shown in the image below.
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.
Integration process
Before you can integrate Lightspeed Retail (X-Series) 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
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).
Domain of the business: It is used and provided by the client.
(For instance: https://.vendhq.com/)
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.
For Enterprise 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 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.
Status for check-in: It will take the status for which the business wants to send the review requests. We support comma-separated values.
Outlet ID: This will be shared by the customer during the initial call. Here is the link to fetch the Outlet ID. NOTE: We support a single Outlet ID for each location. Outlet ID is mandatory for enterprise business.
Status of the sales: It will fetch all sales details as per your values entered. We support comma-separated values.
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.
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 on the left navigation rail of your Birdeye dashboard. At the bottom of the 'Settings' page, click on the 'Authorize LightspeedXSeries’ button under the CRM integrations header.
After you click the authorization button, you will be redirected to the Lightspeed Retail (X-Series) website. Enter the Store URL associated with your Lightspeed Retail (X-Series) and click on the 'Next' button.
Enter the username and password associated with your Lightspeed Retail (X-Series) and click on the 'Sign In' button.
Once you have signed in to your Lightspeed Retail (X-Series) account, Birdeye will ask permission to obtain Customer data from your Lightspeed Retail (X-Series) 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 Lightspeedxseries.
Curl Commands
Before you can integrate Lightspeed Retail (X-Series) 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 --location --request PUT 'https://common-services.Birdeye.com/integration/add/businessintegrationgroup' \--header 'content-type: application/json' \--data-raw '{"integrationGroupTriggers": [{"actionIds": [1],"triggerId": 131,"triggerTypeId": 1},{"actionIds": [1],"triggerId": 131,"triggerTypeId": 1}],"integrationSourceId": 119,"parentBusinessNumber": 157322822486773}'157322822486773 - Business ID - This is Enterprise ID for a multi-location account and Business ID for a single location SMB account
131- Integration Trigger ID - Ask the 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.
Fetch information for all the triggers available for Lightspeed (Curl Command).
Copy this Curl Command
curl -X GET https://common-services.Birdeye.com/integration/trigger/integrationtriggers/sourceid/119 -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": 131,"triggerService": "lightSpeedXSeriesSalesTriggerService","displayName": "LightspeedXSeries Sales Trigger Service","description": "This trigger is used to fetch customer details","active": true,"integrationTriggerType": {"id": 1,"name": "JOB"},"actionGroupId": 1,"sourceIdsList": [119],"triggerName": "Lightspeedxseries Sales Trigger","caseTypeId": 1}]131 - Trigger ID
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": "LIGHTSPEEDXSERIES","sourceCategory": "Retailing","integrationType": "Birdeye API","integrationPlan": "Basic","oauthEnabled": true},"integrationGroupTriggers": [{"triggerId": 131,"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.
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":131,"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.
10716- The Group ID, returned in the previous step, will be entered here.
131-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 --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" :"outlet_id","propertyValue" :"0ac54c19-8c95-11ed-fd4a-64d6fdca06f1"}] }'Outlet ID: you can fetch Outlet ID.
NOTE: This URL appears for a short time in the URL tab. Please check the URL tab just after clicking on the shop.
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 Lightspeed Retail (X-Series) are:
Sales status is invalid.
Integration is beta.
Description
The sales status was found to be false or invalid.
The integration setup is currently set to beta.