# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounts and Settings Webhooks API
  version: 1.0.0
extends: openapi/brevo-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: 6
- target: $.paths['/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhooks are configured on my Brevo account?
      - Can I list only marketing or only transactional webhooks?
      instructions:
      - text: List all my webhooks.
      - text: Show my {type} webhooks.
        slots:
          type: query.type
      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 at my URL when an email is delivered or opened?
      - Can a webhook send events in batches or with custom headers?
      instructions:
      - text: Create a webhook to {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      - text: Create a {type} webhook posting to {url}.
        slots:
          type: requestBody.type
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - Which events is a particular webhook subscribed to?
      - What authentication is set on one of my webhooks?
      instructions:
      - text: Show webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Get the configuration of webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/{webhookId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the URL or events of an existing webhook?
      - Is it possible to turn on batching for a webhook I already created?
      instructions:
      - text: Change the URL of webhook {webhookId} to {url}.
        slots:
          webhookId: path.webhookId
          url: requestBody.url
      - text: Update webhook {webhookId} to listen for {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:
      - Can I stop all notifications from a webhook for good?
      - What happens to events after I delete a webhook?
      instructions:
      - text: Delete webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      - text: Permanently remove webhook {webhookId}.
        slots:
          webhookId: path.webhookId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/export'].post
  update:
    x-apievangelist-phrasing:
      intent: Export webhook event history
      effect: write
      questions:
      - Can I download the history of webhook events as a CSV?
      - Is exporting webhook history an enterprise feature?
      instructions:
      - text: Export my webhook event history.
      - text: Request a webhook history CSV for the account with API key {api_key}.
        slots:
          api_key: header.api-key
      method: generated
      generated: '2026-09-26'