# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Mailchimp Marketing Batch Webhooks API
  version: 1.0.0
extends: openapi/mailchimp-batchwebhooks-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['/batch-webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List batch completion webhooks
      effect: read
      questions:
      - Which webhooks fire when my batch operations finish?
      - How many batch webhooks do I have configured so far?
      instructions:
      - text: List all my batch webhooks.
      - text: Show the first {count} batch completion webhooks.
        slots:
          count: query.count
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch-webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a batch completion webhook
      effect: write
      questions:
      - How can I get notified when a batch request finishes processing?
      - Is there a limit on how many batch webhooks I can create?
      instructions:
      - text: Add a batch webhook that calls {url} when batches complete.
        slots:
          url: requestBody.url
      - text: Register {url} as a batch webhook but leave it disabled for now.
        slots:
          url: requestBody.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch-webhooks/{batch_webhook_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one batch webhook
      effect: read
      questions:
      - What URL does a particular batch webhook call, and is it enabled?
      - Can I fetch a single batch webhook by its ID?
      instructions:
      - text: Get batch webhook {batch_webhook_id}.
        slots:
          batch_webhook_id: path.batch_webhook_id
      - text: Show whether batch webhook {batch_webhook_id} is enabled.
        slots:
          batch_webhook_id: path.batch_webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch-webhooks/{batch_webhook_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a batch webhook
      effect: destructive
      questions:
      - How do I stop batch completion notifications going to an old URL?
      - Can I remove a batch webhook entirely?
      instructions:
      - text: Delete batch webhook {batch_webhook_id}.
        slots:
          batch_webhook_id: path.batch_webhook_id
      - text: Remove batch webhook {batch_webhook_id} so it no longer fires.
        slots:
          batch_webhook_id: path.batch_webhook_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/batch-webhooks/{batch_webhook_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a batch webhook
      effect: write
      questions:
      - Can I change the URL of an existing batch webhook?
      - Is it possible to disable a batch webhook without deleting it?
      instructions:
      - text: Point batch webhook {batch_webhook_id} at {url}.
        slots:
          batch_webhook_id: path.batch_webhook_id
          url: requestBody.url
      - text: Set batch webhook {batch_webhook_id} enabled to {enabled}.
        slots:
          batch_webhook_id: path.batch_webhook_id
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'