# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Webhooks API
  version: 1.0.0
extends: openapi/lightspeed-webhooks-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: 5
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List retail webhooks
      effect: read
      questions:
      - Which webhooks are registered on my retail account?
      - Can I see every event subscription my app has set up?
      instructions:
      - text: List all webhooks on the retail account.
      - text: Show every webhook subscription I've registered.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a retail webhook
      effect: write
      questions:
      - How do I get notified when a sale or product changes?
      - Which event types, like sale.update or inventory.update, can a webhook listen for?
      instructions:
      - text: Create a {type} webhook sending to {url} with active set to {active}.
        slots:
          type: requestBody.type
          url: requestBody.url
          active: requestBody.active
      - text: Subscribe {url} to {type} events, active {active}.
        slots:
          url: requestBody.url
          type: requestBody.type
          active: requestBody.active
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a retail webhook
      effect: read
      questions:
      - Is a particular webhook active and which URL does it call?
      - Can I fetch one webhook's settings by ID?
      instructions:
      - text: Get webhook {webhook}.
        slots:
          webhook: path.webhookId
      - text: Show the URL and event type of webhook {webhook}.
        slots:
          webhook: path.webhookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a retail webhook
      effect: write
      questions:
      - Can I disable a webhook without deleting it?
      - How do I point an existing webhook at a new endpoint?
      instructions:
      - text: Update webhook {webhook} to send {type} events to {url} with active {active}.
        slots:
          webhook: path.webhookId
          type: requestBody.type
          url: requestBody.url
          active: requestBody.active
      - text: Set webhook {webhook} active to {active}, keeping type {type} and URL {url}.
        slots:
          webhook: path.webhookId
          active: requestBody.active
          type: requestBody.type
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a retail webhook
      effect: destructive
      questions:
      - Can I permanently remove a webhook subscription?
      - What's the way to stop receiving events from a webhook for good?
      instructions:
      - text: Delete webhook {webhook}.
        slots:
          webhook: path.webhookId
      - text: Remove webhook subscription {webhook} permanently.
        slots:
          webhook: path.webhookId
      method: generated
      generated: '2026-09-26'