Lightspeed Restaurant K Series API

1.0.0

Body

• baseUrl string(uri)

  The base url of the external platform for non-standard webhooks.

• orderWebhookUrl string

  The url where order notifications will be sent.
  Required for order notification types, see notificationTypes field.
  Example of outbound payload in Get Sample Order Update

• integrationWebhookUrl string

  The url where notifications for activation or deactivation of the customer's integration will be sent.
  Required for integration notification types, see notificationTypes field.
  Example of outbound payload in Get Sample Integration notification

• onboardingWebhookUrl string

  The url where notifications for the customer's integration onboarding will be sent.
  Required for onboarding notification types, see notificationTypes field.
  Example of outbound payload in Get Sample Onboarding notification

• errorsWebhookUrl string

  The url where notifications for any issues will be sent.
  Required for error notification types, see notificationTypes field.
  Example of outbound payload in Get Sample Error notification

• notificationTypes array

  The events that trigger a notification.

  Values are ORDER_OPENED, ORDER_UPDATED, ORDER_CLOSED, ONBOARDING_STARTED, INTEGRATION_ACTIVATED, INTEGRATION_DEACTIVATED, or ERROR.

• displayName string Required

  The official platform name that will be displayed.

• depositSupported boolean

  Whether or not the platform supports deposits.

• ownNotificationsOnly boolean

  When true, notifications will only be sent for orders linked to the reservation platform.

• webhookAuthType string Required

  The type of authentication used by the webhook.

  Values are BASIC_AUTH, BEARER_TOKEN, API_KEYS, OAUTH2, or NONE.

• webhookAuthDetails object Required

  The authentication credentials to be sent with the webhook notifications.

  Hide webhookAuthDetails attributes Show webhookAuthDetails attributes

  • basic object

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

    Hide basic attributes Show basic attributes

    • username string Required

      The basic auth username.

    • password string(password) Required

      The basic auth password.

  • bearer object

    The bearer token that will be sent with the webhook notifications. See Bearer Authentication.

    Hide bearer attributes Show bearer attributes

    • token string(password) Required

      The bearer token.

    • tokenTtl string(date-time)

      Token expiration time in UTC.

  • apiKeys object

    The API keys that will be sent with the webhook notifications. See API Keys.

    Hide apiKeys attributes Show apiKeys attributes

    • headers object
      Hide headers attributes Show headers attributes

      • Additional properties
      • key string
    • parameters object
      Hide parameters attributes Show parameters attributes

      • Additional properties
      • key string
  • oauth2 object

    The OAuth2 credentials that will be sent with the webhook notifications. See OAuth 2.0.

    Hide oauth2 attributes Show oauth2 attributes

    • clientId string Required

      The OAuth2 client ID.

    • clientSecret string(password) Required

      The OAuth2 client secret.

    • clientName string

      The OAuth2 client name.

    • clientAuthorizationMethod string

      The client authorization method. See OAuth2 Client Authentication.

      Values are CLIENT_SECRET_BASIC, CLIENT_SECRET_JWT, or CLIENT_SECRET_POST. Default value is CLIENT_SECRET_BASIC.

    • authorizationGrantType string

      The authorization grant type. See OAuth2 Grant Types.

      Value is CLIENT_CREDENTIALS. Default value is CLIENT_CREDENTIALS.

    • scopes array[string]

      The scopes being granted to the API client.

    • providerTokenUri string(uri) Required

      The external platform URL for getting access tokens by private credentials of the K-Series.

    • providerJwkSetUri string(uri)

      The external platform URL for getting public keys to verify given access tokens on the K-Series side.