# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SimilarWeb Batch Webhooks API
  version: 1.0.0
extends: openapi/similarweb-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['/batch/v4/webhooks/subscribe'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe a URL to webhook events
      effect: write
      questions:
      - How do I get notified when a report completes or new data is released?
      - Can I sign webhook notifications with a secret?
      instructions:
      - text: Subscribe {webhook_url} to {events} events.
        slots:
          webhook_url: requestBody.webhook_url
          events: requestBody.events
      - text: Send report_complete notifications to {webhook_url} signed with {secret}.
        slots:
          webhook_url: requestBody.webhook_url
          secret: requestBody.secret
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/webhooks/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List active webhook subscriptions
      effect: read
      questions:
      - Which webhook subscriptions are active on my account?
      - What URLs are currently receiving event notifications?
      instructions:
      - text: List my active webhook subscriptions.
      - text: Show every webhook endpoint we're subscribed with.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/webhooks/unsubscribe'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a webhook subscription
      effect: destructive
      questions:
      - How do I stop receiving webhook notifications for a subscription?
      - Can I delete a webhook subscription I no longer need?
      instructions:
      - text: Unsubscribe webhook {webhook_id}.
        slots:
          webhook_id: query.webhook_id
      - text: Remove the webhook subscription {webhook_id}.
        slots:
          webhook_id: query.webhook_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/batch/v4/webhooks/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test notification to a webhook
      effect: write
      questions:
      - How can I check that my webhook endpoint is receiving events?
      - Can I fire a test event at a URL before subscribing it?
      instructions:
      - text: Send a test notification to {webhook_url}.
        slots:
          webhook_url: requestBody.webhook_url
      - text: Verify my webhook at {webhook_url} with a test event.
        slots:
          webhook_url: requestBody.webhook_url
      method: generated
      generated: '2026-10-01'