Online Ordering API Readiness Notification Webhook

Add MCP server to your AI tool

Allow AI tools and LLMs to interact with the API documentation portal through MCP.

MCP server URL

https://api-docs.lsk.lightspeed.app/mcp

Standard setup for AI tools providing an mcp.json file

mcp.json 
{
  "Lightspeed Restaurant K-Series MCP server": {
    "url": "https://api-docs.lsk.lightspeed.app/mcp"
  }
}
Close
POST https://webhook.example.com

What your webhook implementation will receive when online ordering API readiness is updated. See the Online Order Readiness guide for setup and integration details.

application/json

Body Required

  • businessLocationId integer(int64) Required

    The unique identifier for the business location.

  • lastUpdatedAt string(date-time) Required

    The timestamp when the online order readiness was last updated

  • status string Required

    The readiness status of the online ordering api

    Values are READY or NOT_READY.

  • type string Required

    Notification type

    Default value is ORDER_API.

  • onlineOrderingApiConfiguration object Required
    Hide onlineOrderingApiConfiguration attributes Show onlineOrderingApiConfiguration attributes object
    • enabled boolean Required
    • orderProfileId integer(int64) | null
    • staffId integer(int64) | null
  • posStatus object Required
    Hide posStatus attributes Show posStatus attributes object
    • salesPeriod string Required

      Values are OPENED or CLOSED.

    • acceptingOnlineOrders boolean Required
    • availableDevices boolean Required

Responses

  • 200

    Your server returns this code if it accepts the callback

POST apeOnline Ordering API Readiness notification
Request examples 
{
  "businessLocationId": 247158188015618,
  "lastUpdatedAt": "2025-10-04T09:40:00.000+00:00",
  "status": "READY",
  "type": "ORDER_API",
  "onlineOrderingApiConfiguration": {
    "enabled": true,
    "orderProfileId": 25769803781,
    "staffId": 3
  },
  "posStatus": {
    "salesPeriod": "OPENED",
    "acceptingOnlineOrders": true,
    "availableDevices": true
  }
}
{
  "businessLocationId": 247158188015618,
  "lastUpdatedAt": "2025-10-04T09:40:00.000+00:00",
  "status": "NOT_READY",
  "type": "ORDER_API",
  "onlineOrderingApiConfiguration": {
    "enabled": false,
    "orderProfileId": null,
    "staffId": null
  },
  "posStatus": {
    "salesPeriod": "CLOSED",
    "acceptingOnlineOrders": false,
    "availableDevices": false
  }
}