# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mailchimp Transactional Webhooks API
  version: 1.0.0
extends: openapi/mailchimp-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: 5
- target: $.paths['/webhooks/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List webhooks on the account
      effect: read
      questions:
      - Which webhooks are configured on my Transactional account?
      - Can I see every webhook URL I've set up?
      instructions:
      - text: List my webhooks.
      - text: Show all webhooks defined under API key {key}.
        slots:
          key: requestBody.key
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a webhook for message events
      effect: write
      questions:
      - How do I get message events like opens and bounces posted to my server?
      - Can I limit a new webhook to only certain events?
      instructions:
      - text: Add a webhook that posts to {url}.
        slots:
          url: requestBody.url
      - text: Create a webhook at {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/info'].post
  update:
    x-apievangelist-phrasing:
      intent: Get details of one webhook
      effect: read
      questions:
      - What URL and events is a specific webhook set to?
      - Can I look up one webhook by its id?
      instructions:
      - text: Get webhook {id}.
        slots:
          id: requestBody.id
      - text: Show the events and URL of webhook {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an existing webhook
      effect: write
      questions:
      - How do I change the URL an existing webhook posts to?
      - Can I change which events an existing webhook receives?
      instructions:
      - text: Point webhook {id} at {url}.
        slots:
          id: requestBody.id
          url: requestBody.url
      - text: Update webhook {id} to post {events} to {url}.
        slots:
          id: requestBody.id
          events: requestBody.events
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/webhooks/delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I remove a webhook I no longer need?
      - Can I stop events from being posted to an old endpoint?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: requestBody.id
      - text: Remove the webhook with id {id}.
        slots:
          id: requestBody.id
      method: generated
      generated: '2026-09-26'