# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Live Direct Marketing Online Webhooks API
  version: 1.0.0
extends: openapi/live-direct-marketing-online-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: 7
- target: $.paths['/api/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhook endpoints
      effect: read
      questions:
      - Which webhook endpoints have I registered?
      - Can I see all the URLs that receive my event notifications?
      instructions:
      - text: List my webhook endpoints.
      - text: Show every webhook URL I've set up.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook endpoint
      effect: write
      questions:
      - How do I start receiving event notifications at my own URL?
      - Can I register a new webhook endpoint?
      instructions:
      - text: Create a new webhook endpoint.
      - text: Register a URL to receive my event notifications.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook endpoint
      effect: destructive
      questions:
      - How do I stop sending events to a webhook URL for good?
      - Can I delete a webhook endpoint I no longer use?
      instructions:
      - text: Delete webhook endpoint {id}.
        slots:
          id: path.id
      - text: Remove webhook {id} permanently.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook endpoint
      effect: write
      questions:
      - Can I change the settings of an existing webhook endpoint?
      - What can I edit on a webhook I already created?
      instructions:
      - text: Update webhook endpoint {id}.
        slots:
          id: path.id
      - text: Edit the configuration of existing webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webhook's delivery history
      effect: read
      questions:
      - Did my webhook deliveries succeed or fail?
      - Can I filter a webhook's delivery log by status?
      instructions:
      - text: Show delivery history for webhook {id}.
        slots:
          id: path.id
      - text: List deliveries of webhook {id} with status {status}.
        slots:
          id: path.id
          status: query.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/deliveries/{id}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry one webhook delivery
      effect: write
      questions:
      - Can I resend a single failed webhook delivery?
      - How do I retry one specific delivery attempt?
      instructions:
      - text: Retry webhook delivery {id}.
        slots:
          id: path.id
      - text: Resend the single failed delivery {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/webhooks/{id}/retrigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Retrigger recent deliveries for a webhook
      effect: write
      questions:
      - Can I replay the last several deliveries to a webhook endpoint?
      - What re-sends a batch of recent events to my endpoint after an outage?
      instructions:
      - text: Retrigger the last deliveries for webhook endpoint {id}.
        slots:
          id: path.id
      - text: Replay recent events to endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'