Body Required

• baseUrl string(uri)

  The base URL of the external platform (optional).

• depositSupported boolean

  Whether or not the platform supports deposits.

• displayName string Required

  The official platform name that will be displayed.

• errorsWebhookUrl string

  The URL where notifications for any issues will be sent.
  Required for error notificationTypes.
  See Get Sample Error notification.

• integrationWebhookUrl string

  The URL where notifications for activation or deactivation of the customer's integration will be sent.
  Required for integration notificationTypes.
  See Integration notification.

• notificationTypes array[string]

  The events that trigger a notification.

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

• onboardingWebhookUrl string

  The URL where notifications for the customer's integration onboarding will be sent.
  Required for onboarding notificationTypes.
  See Onboarding notification.

• orderWebhookUrl string

  The URL where order notifications will be sent.
  Required for order notificationTypes.
  See Order Notification.

• posReservationUpdateWebhookUrl string

  The URL where notifications about reservation changes on POS will be sent.

• ownNotificationsOnly boolean

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

• webhookAuthDetails object Required

  The authentication credentials to be sent with the webhook notifications.

  Hide webhookAuthDetails attributes Show webhookAuthDetails attributes object

  • apiKeys object

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

    Hide apiKeys attributes Show apiKeys attributes object

    • headers object
      Hide headers attribute Show headers attribute object

      • * string Additional properties

        Key-value pairs of arbitrary static headers to send with the webhook request.

    • parameters object
      Hide parameters attribute Show parameters attribute object

      • * string Additional properties

        Key-value pairs of arbitrary static query parameters to send with the webhook request.

  • basic object

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

    Hide basic attributes Show basic attributes object

    • password string(password) Required

      The basic auth password.

    • username string Required

      The basic auth username.

  • bearer object

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

    Hide bearer attributes Show bearer attributes object

    • token string(password) Required

      The bearer token.

    • ttl string(date-time)

      Token expiration time in UTC.

  • oauth2 object

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

    Hide oauth2 attributes Show oauth2 attributes object

    • authorizationGrantType string

      The authorization grant type. See OAuth2 Grant Types.

      Value is CLIENT_CREDENTIALS. Default value is CLIENT_CREDENTIALS.

    • 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.

    • clientId string Required

      The OAuth2 client ID.

    • clientName string

      The OAuth2 client name.

    • clientSecret string(password) Required

      The OAuth2 client secret.

    • providerJwkSetUri string(uri)

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

    • providerTokenUri string(uri) Required

      The external platform URL for getting access tokens by private credentials.

    • scopes array[string]

      The scopes being granted to the API client.

• webhookAuthType string Required

  The type of authentication used by the webhook.

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

• allowCourseNumberUpdates boolean

  If true, table statuses can be customized using a number format.

  Default value is false.

• inServiceTableStatuses array[object]

  List of customizable table statuses that will be used to notify platforms about reservation progress with outbound API.

  Hide inServiceTableStatuses attributes Show inServiceTableStatuses attributes object

  • statusLabel string Required

    The unique text which will be displayed in the back-office for users.

  • statusValue string Required

    The unique code which will be used for outbound communication within table status mapping.

  • sequence integer(int32) Required

    This number is used to resolve collisions between statuses in order of highest priority.

• allowedPosStatuses array[string]

  External reservation statuses for platforms.

  Values are ON_HOLD, SCHEDULED, PARTIALLY_ARRIVED, ARRIVED, PARTIALLY_SEATED, SEATED, DEPARTED, CANCELLED, NO_SHOW, or ERROR.