Lightspeed Restaurant K Series API
1.0.0

Lightspeed Restaurant offers a REST API in order to communicate with the data in the system. These APIs are built using the RESTful standards and adhere to the basic verb interactions as defined by the REST standard.

These services are in continuous development and subject to change. Find our versioning policy here.

This is the documentation for version 1.0.0 of the API. Last update on May 1, 2024.

Base URL 
https://api.trial.lsk.lightspeed.app

Register a new webhook endpoint

PUT /r/wh/1/webhook
OAuth2

Register a webhook endpoint

application/json

Body Required

  • endpointId string Required

    The unique endpoint ID for example you can use your company name

  • password string

    he password for basic auth

  • url string Required

    The endpoint URL

  • username string

    The username for basic auth

  • withBasicAuth boolean

    If basic auth should be used, defaults to false

Responses

PUT /r/wh/1/webhook 
curl \
 -X PUT https://api.trial.lsk.lightspeed.app/r/wh/1/webhook \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"endpointId":"string","password":"string","url":"string","username":"string","withBasicAuth":true}'
Request example 
{
  "endpointId": "string",
  "password": "string",
  "url": "string",
  "username": "string",
  "withBasicAuth": true
}
Response examples (200) 
{
  "endpointId": "string",
  "password": "string",
  "url": "string",
  "username": "string",
  "withBasicAuth": true
}
Response examples (400) 
{
  "status": "400",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}
Response examples (403) 
{
  "status": "403",
  "timestamp": "2024-05-04T09:42:00+00:00",
  "message": "string",
  "apiSubExceptions": [
    {
      "field": "string",
      "rejectedValue": "string",
      "message": "string"
    }
  ]
}