# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Snov.io Webhooks API
  version: 1.0.0
extends: openapi/snov-io-webhooks-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: 4
- target: $.paths['/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook subscriptions
      effect: read
      questions:
      - Which webhooks are currently subscribed on my account?
      - Can I see all my webhook subscriptions and their events?
      instructions:
      - text: List my webhooks.
      - text: Show every webhook subscription on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a webhook to an event
      effect: write
      questions:
      - How do I get real-time notifications when an event happens?
      - Can I create a webhook that starts out inactive?
      instructions:
      - text: Subscribe {url} to the {event} event.
        slots:
          url: requestBody.url
          event: requestBody.event
      - text: Create a webhook for {event} posting to {url} with status {status}.
        slots:
          event: requestBody.event
          url: requestBody.url
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook subscription
      effect: write
      questions:
      - Can I change the URL of a webhook I already set up?
      - Is it possible to deactivate an existing webhook without deleting it?
      instructions:
      - text: Point existing webhook {id} at {url} for event {event}.
        slots:
          id: path.id
          url: requestBody.url
          event: requestBody.event
      - text: Set webhook {id} ({event} to {url}) to status {status}.
        slots:
          id: path.id
          event: requestBody.event
          url: requestBody.url
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook subscription
      effect: destructive
      questions:
      - How do I stop receiving webhook notifications permanently?
      - Can I remove a webhook subscription I no longer need?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove webhook subscription {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'