Add authentication by XApiKey

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

OAuth2

Activate XApiKey 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 API keys that will be sent with the webhook notifications. See API Keys.

headers object
Hide headers attributes Show headers attributes
- Additional properties
- key string
parameters object
Hide parameters attributes Show parameters attributes
- Additional properties
- key string

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/api-keys

curl \
 -X PATCH https://api.lsk.lightspeed.app/reservation/api/1/platform/MyPlatform/webhook/auth/api-keys \
 -H "Authorization: Bearer $ACCESS_TOKEN" \
 -H "Content-Type: application/json" \
 -d '{"headers":{"X-API-ID":"Example-x-api-id","X-API-SECRET":"Example-x-api-secret"},"parameters":{"key":"string"}}'

Request examples

{
  "headers": {
    "X-API-ID": "Example-x-api-id",
    "X-API-SECRET": "Example-x-api-secret"
  },
  "parameters": {
    "key": "string"
  }
}