API Evangelist conversational phrasing for Webhooks API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Webhooks API
  version: 1.0.0
extends: openapi/qliksense-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: 7
- target: $.paths['/api/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are configured in my Qlik tenant?
      - Can I find only the disabled webhooks, or those for a given event type?
      instructions:
      - text: List all webhooks I have access to.
      - text: Show webhooks subscribed to {eventTypes}.
        slots:
          eventTypes: query.eventTypes
      - text: List webhooks where enabled is {enabled}.
        slots:
          enabled: query.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I subscribe a URL to tenant events with a webhook?
      - Can I sign webhook deliveries with a secret?
      - What role is needed to create a tenant-level webhook?
      instructions:
      - text: Create webhook {name} sending to {url}.
        slots:
          name: requestBody.name
          url: requestBody.url
      - text: Create webhook {name} posting {eventTypes} events to {url}.
        slots:
          name: requestBody.name
          eventTypes: requestBody.eventTypes
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - Where can I see one webhook's settings and target URL?
      - Why was a particular webhook disabled?
      instructions:
      - text: Get webhook {id}.
        slots:
          id: path.id
      - text: Show the configuration of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace all of a webhook's properties
      effect: write
      questions:
      - Does a full webhook update clear the fields I leave out?
      - Can I rewrite a webhook completely with a new URL and name?
      instructions:
      - text: Fully replace webhook {id} with name {name} and URL {url}.
        slots:
          id: path.id
          name: requestBody.name
          url: requestBody.url
      - text: Overwrite webhook {id} to send to {url} as {name}.
        slots:
          id: path.id
          url: requestBody.url
          name: requestBody.name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - Can I delete a webhook I no longer need?
      - What stops event deliveries to an endpoint permanently?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook {id} for good.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change selected webhook properties
      effect: write
      questions:
      - Can I just toggle a webhook on or off without resending everything?
      - What is the partial update option for a webhook?
      instructions:
      - text: Patch webhook {id} to re-enable it.
        slots:
          id: path.id
      - text: Change one property on webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/webhooks/event-types'].get
  update:
    x-apievangelist-phrasing:
      intent: List subscribable webhook event types
      effect: read
      questions:
      - Which event types can a webhook subscribe to?
      - Is there a catalog of events available for webhooks?
      instructions:
      - text: List the webhook event types I can subscribe to.
      - text: Show all available webhook events.
      method: generated
      generated: '2026-09-26'