Get Sample Integration Notification

GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample
OAuth2

Returns an example of an integration notification. These notifications are sent to the URL provided in theintegrationWebhookUrl field.

Path parameters

  • platform-code string Required

    The unique code assigned to the reservation platform.

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

Responses

  • 200 application/json

    OK

    Hide response attributes Show response attributes object
    • businessLocationId integer(int64) Required

      The K-Series business location ID.

    • notificationType string Required

      The type of notification.

      Values are ACTIVATED or DEACTIVATED.

    • 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_-]+.

    • platformRestaurantId string Required

      The external platform ID for the restaurant.

      Format should match the following pattern: [a-zA-Z0-9_-]+.
GET /reservation/api/1/platform/{platform-code}/integration-webhook-sample 
curl \
 -X GET https://api.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/integration-webhook-sample \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "businessLocationId": 9765040300495493,
  "notificationType": "ACTIVATED",
  "platformCode": "MyPlatform",
  "platformRestaurantId": "Restaurant-123"
}