Add authentication with BasicAuth

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth
OAuth2

Activate BasicAuth authentication for webhooks.

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

application/json

Body Required

  • password string(password) Required

    The basic auth password.

  • username string Required

    The basic auth username.

Responses

  • 200 application/json

    Accepted

    Hide response attributes Show response attributes object
    • accepted boolean Required

      Whether the webhook request was accepted.

    • currentAuthType string Required

      The current authentication type.

      Values are BASIC_AUTH, BEARER_TOKEN, API_KEYS, or OAUTH2.
  • 400

    Non relevant request

  • 403

    Scope 'reservation-{platform-code}' not found in the token

  • 404

    Platform not found

PATCH /reservation/api/1/platform/{platform-code}/webhook/auth/basic-auth 
curl \
 -X PATCH https://api.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/webhook/auth/basic-auth \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"password":"Example-Password","username":"LightspeedKSeries"}'
Request examples 
{
  "password": "Example-Password",
  "username": "LightspeedKSeries"
}
Response examples (200) 
{
  "accepted": true,
  "currentAuthType": "BASIC_AUTH"
}