# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Knowledge Webhook Management API
  version: 1.0.0
extends: openapi/ada-webhook-management-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 8
- target: $.paths['/v2/webhooks/'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - What webhooks are configured for my AI Agent?
      - Can I page through my webhook subscriptions?
      instructions:
      - text: List my webhooks.
      - text: Show {limit} webhooks after cursor {cursor}.
        slots:
          limit: query.limit
          cursor: query.cursor
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to webhook events
      effect: write
      questions:
      - How do I get Ada to send events to my server?
      - Can I subscribe a webhook to only certain event types?
      instructions:
      - text: Create a webhook that sends events to {url}.
        slots:
          url: requestBody.url
      - text: Subscribe {url} to the event types {event_filters}.
        slots:
          url: requestBody.url
          event_filters: requestBody.event_filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's details
      effect: read
      questions:
      - How do I check which URL and events one webhook is set to?
      - Is a particular webhook enabled right now?
      instructions:
      - text: Get webhook {id}.
        slots:
          id: path.id
      - text: Show the URL and event filters of webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop sending events to an endpoint permanently?
      - Can I remove a webhook subscription I no longer need?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove the webhook subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change or disable a webhook
      effect: write
      questions:
      - How do I pause a webhook without deleting it?
      - Can I point an existing webhook at a new URL?
      instructions:
      - text: Set enabled to {enabled} on webhook {id}.
        slots:
          enabled: requestBody.enabled
          id: path.id
      - text: Change the URL of webhook {id} to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Update the event filters on webhook {id} to {event_filters}.
        slots:
          id: path.id
          event_filters: requestBody.event_filters
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/{id}/secret/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's signing secret
      effect: read
      questions:
      - How do I verify that incoming webhook payloads really came from Ada?
      - Where can I find the signing secret for a webhook?
      instructions:
      - text: Get the signing secret for webhook {id}.
        slots:
          id: path.id
      - text: Show me the key to verify payloads from webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/webhooks/{id}/secret/rotate/'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a webhook's signing secret
      effect: destructive
      questions:
      - How do I rotate a webhook signing secret that may have leaked?
      - Can I supply my own key when rotating a webhook secret?
      instructions:
      - text: Rotate the signing secret on webhook {id}.
        slots:
          id: path.id
      - text: Rotate webhook {id}'s secret to the custom key {key}.
        slots:
          id: path.id
          key: requestBody.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/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?
      - What kinds of events does Ada emit to webhooks?
      instructions:
      - text: List all webhook event types.
      - text: Show me every event I can subscribe a webhook to.
      method: generated
      generated: '2026-10-01'