Lightspeed · JSON Structure

Restaurant K Series Staff Api Webhook Dto Structure

staff-apiWebhookDto schema from Lightspeed Restaurant K Series API

Type: object Properties: 7
POSRetailRestaurantEcommerce

staff-apiWebhookDto is a JSON Structure definition published by Lightspeed, describing 7 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

uuid notificationType url webhookName businessLocationId createdAt updatedAt

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-webhook-dto-structure.json",
  "name": "staff-apiWebhookDto",
  "description": "staff-apiWebhookDto schema from Lightspeed Restaurant K Series API",
  "type": "object",
  "properties": {
    "uuid": {
      "type": "uuid",
      "description": "The unique identifier for the webhook.",
      "example": "e95c2cc5-4489-4025-a7e2-a34faeaa5f9d"
    },
    "notificationType": {
      "description": "The type of webhook notification.",
      "type": "string",
      "enum": [
        "shift.created",
        "shift.updated",
        "shift.deleted"
      ]
    },
    "url": {
      "type": "string",
      "description": "The URL for the webhook."
    },
    "webhookName": {
      "type": "string",
      "description": "The name for the webhook.",
      "example": "My Awesome Webhook"
    },
    "businessLocationId": {
      "type": "int64",
      "description": "The unique identifier for the business location.",
      "example": 1234567890
    },
    "createdAt": {
      "type": "datetime",
      "description": "The creation time of the webhook."
    },
    "updatedAt": {
      "type": "datetime",
      "description": "The last update time of the webhook."
    }
  }
}