# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: 'API Evangelist conversational phrasing for Lightspeed Restaurant K Series Order and Pay: Webhook API'
  version: 1.0.0
extends: openapi/lightspeed-order-and-pay-webhook-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 7
- target: $.paths['/o/wh/1/webhook'].put
  update:
    x-apievangelist-phrasing:
      intent: Create an order status webhook
      effect: write
      questions:
      - How do I set up a webhook to get order status updates?
      - Can a new webhook use basic auth on my endpoint?
      instructions:
      - text: Create a webhook for endpoint {endpointId} that posts to {url}.
        slots:
          endpointId: requestBody.endpointId
          url: requestBody.url
      - text: Configure a new webhook {endpointId} at {url} subscribed to {subscribeTo}.
        slots:
          endpointId: requestBody.endpointId
          url: requestBody.url
          subscribeTo: requestBody.subscribeTo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing webhook
      effect: write
      questions:
      - How do I change the URL of a webhook I already configured?
      - Which webhook settings reset to defaults if I leave them out of an update?
      instructions:
      - text: Update existing webhook {endpointId} to post to {url}.
        slots:
          endpointId: requestBody.endpointId
          url: requestBody.url
      - text: 'Change webhook {endpointId} at {url} to expand payments: {expandPayments}.'
        slots:
          endpointId: requestBody.endpointId
          url: requestBody.url
          expandPayments: requestBody.expandPayments
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook/{endpointId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a webhook
      effect: read
      questions:
      - How do I see how a webhook endpoint is configured?
      - What URL and subscriptions does my webhook currently have?
      instructions:
      - text: Get the webhook with endpoint ID {endpointId}.
        slots:
          endpointId: path.endpointId
      - text: Show the configuration of webhook {endpointId}.
        slots:
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook/{endpointId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop receiving order webhooks entirely?
      - Can I delete a webhook endpoint I no longer use?
      instructions:
      - text: Delete webhook {endpointId}.
        slots:
          endpointId: path.endpointId
      - text: Remove the webhook endpoint {endpointId} completely.
        slots:
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook/{endpointId}/business-locations'].get
  update:
    x-apievangelist-phrasing:
      intent: List locations enabled on a webhook
      effect: read
      questions:
      - Which business locations are attached to my webhook?
      - How do I check which sites will send item availability webhooks?
      instructions:
      - text: List the business locations added to webhook {endpointId}.
        slots:
          endpointId: path.endpointId
      - text: Show which locations are enabled on webhook {endpointId}.
        slots:
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Enable a webhook for a business location
      effect: write
      questions:
      - How do I get item availability notifications for a location?
      - Do order and payment webhooks need a business location added?
      instructions:
      - text: Add business location {businessLocationId} to webhook {endpointId}.
        slots:
          businessLocationId: path.businessLocationId
          endpointId: path.endpointId
      - text: Enable webhook {endpointId} for item notifications at location {businessLocationId}.
        slots:
          endpointId: path.endpointId
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/wh/1/webhook/{endpointId}/business-locations/{businessLocationId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a business location from a webhook
      effect: destructive
      questions:
      - How do I stop one location from sending events to my webhook?
      - Can I detach a single site from a webhook without deleting it?
      instructions:
      - text: Remove business location {businessLocationId} from webhook {endpointId}.
        slots:
          businessLocationId: path.businessLocationId
          endpointId: path.endpointId
      - text: Detach location {businessLocationId} from webhook endpoint {endpointId} but keep the webhook.
        slots:
          businessLocationId: path.businessLocationId
          endpointId: path.endpointId
      method: generated
      generated: '2026-09-26'