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

The basic authentication credentials that will be sent with the webhook notifications. See Basic Authentication.

  • username string Required

    The basic auth username.

  • password string(password) Required

    The basic auth password.

Responses

  • 200

    Accepted

  • 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.trial.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/webhook/auth/basic-auth \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"username":"LightspeedKSeries","password":"Example-Password"}'
Request examples 
{
  "username": "LightspeedKSeries",
  "password": "Example-Password"
}