Lightspeed · JSON Structure

Restaurant K Series Reservation Service Platform Oauth2 Webhook Structure

The OAuth2 credentials that will be sent with the webhook notifications. See [OAuth 2.0](https://oauth.net/2/).

Type: object Properties: 8 Required: 3
POSRetailRestaurantEcommerce

reservation-servicePlatformOAuth2Webhook is a JSON Structure definition published by Lightspeed, describing 8 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

authorizationGrantType clientAuthorizationMethod clientId clientName clientSecret providerJwkSetUri providerTokenUri scopes

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/lightspeed-pos/refs/heads/main/json-structure/restaurant-k-series-reservation-service-platform-oauth2-webhook-structure.json",
  "name": "reservation-servicePlatformOAuth2Webhook",
  "description": "The OAuth2 credentials that will be sent with the webhook notifications. See [OAuth 2.0](https://oauth.net/2/).",
  "type": "object",
  "properties": {
    "authorizationGrantType": {
      "default": "CLIENT_CREDENTIALS",
      "description": "The authorization grant type. See [OAuth2 Grant Types](https://oauth.net/2/grant-types/).",
      "enum": [
        "CLIENT_CREDENTIALS"
      ],
      "example": "CLIENT_CREDENTIALS",
      "type": "string"
    },
    "clientAuthorizationMethod": {
      "default": "CLIENT_SECRET_BASIC",
      "description": "The client authorization method. See [OAuth2 Client Authentication](https://oauth.net/2/client-authentication/).",
      "enum": [
        "CLIENT_SECRET_BASIC",
        "CLIENT_SECRET_JWT",
        "CLIENT_SECRET_POST"
      ],
      "example": "CLIENT_SECRET_BASIC",
      "type": "string"
    },
    "clientId": {
      "description": "The OAuth2 client ID.",
      "example": "LightspeedKSeries",
      "type": "string"
    },
    "clientName": {
      "description": "The OAuth2 client name.",
      "example": "LightspeedKSeries",
      "type": "string"
    },
    "clientSecret": {
      "description": "The OAuth2 client secret.",
      "example": "Example-Client-Secret",
      "format": "password",
      "type": "string"
    },
    "providerJwkSetUri": {
      "description": "The external platform URL for getting public keys to verify given access tokens on the K-Series side.",
      "example": "https://my.platform/public-keys",
      "type": "uri"
    },
    "providerTokenUri": {
      "description": "The external platform URL for getting access tokens by private credentials.",
      "example": "https://my.platform/emitter/token",
      "type": "uri"
    },
    "scopes": {
      "description": "The scopes being granted to the API client.",
      "example": [
        "webhooks-api"
      ],
      "items": {
        "type": "string"
      },
      "type": "array",
      "uniqueItems": true
    }
  },
  "required": [
    "clientId",
    "clientSecret",
    "providerTokenUri"
  ]
}