# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for SendPulse Bulk Email Webhooks API
  version: 1.0.0
extends: openapi/sendpulse-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: 5
- target: $.paths['/v2/email-service/webhook'].get
  update:
    x-apievangelist-phrasing:
      intent: List email service webhooks
      effect: read
      questions:
      - Which webhooks are set up to receive my email events?
      - Can I see all configured email service webhooks?
      instructions:
      - text: List my email service webhooks.
      - text: Show every webhook configured for email events.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/webhook'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook for email events
      effect: write
      questions:
      - How do I get notified at my URL when emails are opened or bounce?
      - Can I choose which email events a new webhook tracks?
      instructions:
      - text: Create a webhook to {url} for events {actions}.
        slots:
          url: requestBody.url
          actions: requestBody.actions
      - text: Send email events {actions} to my endpoint {url}.
        slots:
          actions: requestBody.actions
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/webhook/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook's details
      effect: read
      questions:
      - What URL and events does a particular email webhook use?
      - Can I look up one webhook by its ID?
      instructions:
      - text: Show webhook {id}.
        slots:
          id: path.id
      - text: Get the configuration of email webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/webhook/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's URL
      effect: write
      questions:
      - How do I point an existing email webhook at a new endpoint?
      - Can I change the delivery URL of a webhook?
      instructions:
      - text: Change the URL of webhook {id} to {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Point existing email webhook {id} at {url}.
        slots:
          id: path.id
          url: requestBody.url
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/email-service/webhook/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I stop sending email events to a webhook?
      - Can I remove a webhook configuration?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Remove the email event webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'