# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Convoy API Reference Event Deliveries API
  version: 1.0.0
extends: openapi/convoy-event-deliveries-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['/v1/projects/{projectID}/eventdeliveries'].get
  update:
    x-apievangelist-phrasing:
      intent: List event deliveries with filters
      effect: read
      questions:
      - Which webhook deliveries failed in my project over the last day?
      - Can I filter deliveries by endpoint, event type or status?
      - How do I find all deliveries for a given idempotency key?
      instructions:
      - text: List event deliveries in project {projectID}.
        slots:
          projectID: path.projectID
      - text: Show deliveries with status {status} to endpoint {endpointId} between {startDate} and {endDate}.
        slots:
          status: query.status
          endpointId: query.endpointId
          startDate: query.startDate
          endDate: query.endDate
      - text: List the deliveries created for event {eventId}.
        slots:
          eventId: query.eventId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/batchretry'].post
  update:
    x-apievangelist-phrasing:
      intent: Retry many event deliveries at once
      effect: write
      questions:
      - Can I retry every failed delivery to an endpoint in one go?
      - What's the way to bulk retry deliveries that match a status and date range?
      instructions:
      - text: Batch retry all deliveries with status {status} in project {projectID}.
        slots:
          status: query.status
          projectID: path.projectID
      - text: Retry in bulk every delivery to endpoint {endpointId} from {startDate} to {endDate}.
        slots:
          endpointId: query.endpointId
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/forceresend'].post
  update:
    x-apievangelist-phrasing:
      intent: Force resend deliveries that already succeeded
      effect: write
      questions:
      - Can I resend a webhook that was already delivered successfully?
      - How do I force Convoy to send a list of successful deliveries again?
      instructions:
      - text: Force resend the successful deliveries {ids} in project {projectID}.
        slots:
          ids: requestBody.ids
          projectID: path.projectID
      - text: 'Redeliver these already-successful event deliveries again: {ids}.'
        slots:
          ids: requestBody.ids
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve an event delivery
      effect: read
      questions:
      - What is the current status of one particular webhook delivery?
      - Where do I look up a single event delivery by its ID?
      instructions:
      - text: Get event delivery {eventDeliveryID} in project {projectID}.
        slots:
          eventDeliveryID: path.eventDeliveryID
          projectID: path.projectID
      - text: Show me the status of delivery {eventDeliveryID}.
        slots:
          eventDeliveryID: path.eventDeliveryID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/resend'].put
  update:
    x-apievangelist-phrasing:
      intent: Retry a single event delivery
      effect: write
      questions:
      - How do I retry just one failed webhook delivery?
      - Can I manually retry a delivery instead of waiting for the next automatic attempt?
      instructions:
      - text: Retry event delivery {eventDeliveryID} in project {projectID}.
        slots:
          eventDeliveryID: path.eventDeliveryID
          projectID: path.projectID
      - text: Retry the failed delivery {eventDeliveryID} now.
        slots:
          eventDeliveryID: path.eventDeliveryID
      method: generated
      generated: '2026-10-01'