Onboarding notification

POST https://webhook.example.com

These notifications are sent to the URL provided in theonboardingWebhookUrl field.

application/json

Body Required

businessInformation object Required

Additional properties are allowed.
Hide businessInformation attributes Show businessInformation attributes object
- businessLocationId integer(int64) Required
  
  The unique identifier of the business location.
- city string
  
  The city of the company.
- country string
  
  The country code of the company.
- name string Required
  
  The company name in Lightspeed Backoffice.
- state string
  
  The state of the company.
- street1 string
  
  The primary street of the company.
- street2 string
  
  The secondary street of the company.
- zip string
  
  The zip code of the company.
epochSecondsDeadlineUtc integer(int64) Required

The epoch time in seconds until which the onboarding process remains active.
onboardingId string Required

The unique identifier of the integration process that has started onboarding.
platformCode string Required

The unique code assigned to the reservation platform.

Maximum length is 11. Format should match the following pattern: [a-zA-Z0-9_-]+.
platformRestaurantReference string Required

The alias for a restaurant on an external platform, such as its unique identifier or local unique name.

Format should match the following pattern: [a-zA-Z0-9_-]+.

Responses

200

Your server returns this code if it accepts the callback.

POST Onboarding notification

Request examples

{
  "businessInformation": {
    "businessLocationId": 9765040300495493,
    "city": "Genève",
    "country": "CH",
    "name": "Le Gâteau",
    "state": "Canton de Genève",
    "street1": "Rue de la Servette 10",
    "street2": "Suite 2",
    "zip": "101201"
  },
  "epochSecondsDeadlineUtc": 1711628625,
  "onboardingId": "84f16177-98c5-4010-a7ab-d00144d1dede",
  "platformCode": "MyPlatform",
  "platformRestaurantReference": "Schnitzel_and_Kartoffel"
}