# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Drip Webhooks API
  version: 1.0.0
extends: openapi/drippay-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: 11
- target: $.paths['/v1/webhooks/events'].get
  update:
    x-apievangelist-phrasing:
      intent: List available webhook event types
      effect: read
      questions:
      - Which event types can I subscribe a webhook to?
      - What does each webhook event type mean?
      instructions:
      - text: List all available webhook event types.
      - text: Show the webhook events I can subscribe to, with descriptions.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks'].get
  update:
    x-apievangelist-phrasing:
      intent: List webhooks
      effect: read
      questions:
      - Which webhook endpoints have I registered, and how are their deliveries doing?
      - Can I see delivery stats for all my webhooks at once?
      instructions:
      - text: List my webhooks.
      - text: Show every webhook endpoint with its delivery statistics.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a webhook endpoint
      effect: write
      questions:
      - How do I get real-time notifications when a charge succeeds?
      - Is the webhook signing secret shown more than once after creation?
      instructions:
      - text: Create a webhook at {url} for events {events}.
        slots:
          url: requestBody.url
          events: requestBody.events
      - text: Register {url} to receive {events}, described as {description}.
        slots:
          url: requestBody.url
          events: requestBody.events
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a webhook
      effect: read
      questions:
      - What URL and events is a specific webhook configured with?
      - Can I see delivery stats for one webhook?
      instructions:
      - text: Show webhook {id}.
        slots:
          id: path.id
      - text: Get the configuration and stats for webhook {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a webhook
      effect: destructive
      questions:
      - How do I permanently remove a webhook endpoint?
      - Can a deleted webhook be restored?
      instructions:
      - text: Delete webhook {id}.
        slots:
          id: path.id
      - text: Permanently remove the webhook endpoint {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a webhook
      effect: write
      questions:
      - Can I change the URL of an existing webhook?
      - How do I temporarily disable a webhook without deleting it?
      instructions:
      - text: Point webhook {id} at {url}.
        slots:
          id: path.id
          url: requestBody.url
      - text: Change webhook {id} to listen for {events}.
        slots:
          id: path.id
          events: requestBody.events
      - text: Set webhook {id} active to {isActive}.
        slots:
          id: path.id
          isActive: requestBody.isActive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}/rotate-secret'].post
  update:
    x-apievangelist-phrasing:
      intent: Rotate a webhook's signing secret
      effect: write
      questions:
      - My webhook secret leaked — how do I generate a new one?
      - What should I do right after rotating a webhook's HMAC secret?
      instructions:
      - text: Rotate the signing secret for webhook {id}.
        slots:
          id: path.id
      - text: Generate a new HMAC secret for {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}/deliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List a webhook's delivery attempts
      effect: read
      questions:
      - Which recent deliveries to my webhook failed?
      - Can I see the latest delivery attempts for one webhook endpoint?
      instructions:
      - text: List recent deliveries for webhook {id}.
        slots:
          id: path.id
      - text: Show the last {limit} delivery attempts to webhook {id}.
        slots:
          limit: query.limit
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}/deliveries/{deliveryId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single webhook delivery
      effect: read
      questions:
      - What response did my endpoint return for one particular webhook delivery?
      - Can I inspect the details of a single delivery attempt?
      instructions:
      - text: Show delivery {deliveryId} for webhook {id}.
        slots:
          deliveryId: path.deliveryId
          id: path.id
      - text: Get details of attempt {deliveryId} on {id}.
        slots:
          deliveryId: path.deliveryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}/deliveries/{deliveryId}/retry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry a failed webhook delivery
      effect: write
      questions:
      - My endpoint was down — can I resend a failed webhook delivery?
      - How do I manually retry one delivery attempt?
      instructions:
      - text: Retry delivery {deliveryId} on webhook {id}.
        slots:
          deliveryId: path.deliveryId
          id: path.id
      - text: Resend failed delivery {deliveryId} to {id}.
        slots:
          deliveryId: path.deliveryId
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/webhooks/{id}/test'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a test event to a webhook
      effect: write
      questions:
      - How can I check that my webhook endpoint is actually receiving events?
      - Can I fire a sample event at a webhook to test it?
      instructions:
      - text: Send a test event to webhook {id}.
        slots:
          id: path.id
      - text: Ping webhook {id} to verify it works.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'