Lightspeed · JSON Structure

Restaurant K Series Staff Api Create Webhook Request Structure

staff-apiCreateWebhookRequest schema from Lightspeed Restaurant K Series API

Type: object Properties: 3 Required: 3
POSRetailRestaurantEcommerce

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

Properties

notificationType url webhookName

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-staff-api-create-webhook-request-structure.json",
  "name": "staff-apiCreateWebhookRequest",
  "description": "staff-apiCreateWebhookRequest schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "notificationType": {
      "description": "The type of webhook notification.",
      "type": "string",
      "enum": [
        "shift.created",
        "shift.updated",
        "shift.deleted"
      ]
    },
    "url": {
      "type": "uri",
      "description": "The URL for the webhook."
    },
    "webhookName": {
      "type": "string",
      "description": "The name for the webhook."
    }
  },
  "required": [
    "notificationType",
    "url",
    "webhookName"
  ]
}