# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Attentive Webhooks API
  version: 1.0.0
extends: openapi/attentive-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: 4
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - How do I see which webhooks I have set up?
      - What URLs are my existing webhooks sending events to?
      instructions:
      - text: List my webhooks.
      - text: Show every webhook and the events each one receives.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook
      effect: write
      questions:
      - How do I get notified when someone subscribes via SMS?
      - Which event types can a new webhook subscribe to?
      instructions:
      - text: Create a webhook to {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      - text: Send email.opened and email.message_link_click events to {url}.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - How do I change the destination URL of an existing webhook?
      - Can I disable a webhook temporarily without deleting it?
      instructions:
      - text: Point webhook {webhookId} at {url}.
        slots:
          webhookId: path.webhookId
          url: requestBody.url
      - text: Disable webhook {webhookId} by setting disabled to {disabled}.
        slots:
          webhookId: path.webhookId
          disabled: requestBody.disabled
      - text: Change the events on webhook {webhookId} to {events}.
        slots:
          webhookId: path.webhookId
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I permanently remove a webhook?
      - Can I delete a webhook I no longer want events sent to?
      instructions:
      - text: Delete webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Remove webhook {webhookId} for good.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'