Convoy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Convoy API Reference Delivery Attempts API

3 actions 3 updates phrasing extends openapi/convoy-delivery-attempts-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Convoy's API. It is a proposal applied on top of the contract, not a document Convoy publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 3

$.info

$.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts'].get

$.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID}'].get

OpenAPI Overlay

# 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 Delivery Attempts API
  version: 1.0.0
extends: openapi/convoy-delivery-attempts-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: 2
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts'].get
  update:
    x-apievangelist-phrasing:
      intent: List the delivery attempts for an event delivery
      effect: read
      questions:
      - How do I see every attempt Convoy made to deliver one webhook?
      - Can I check how many times a failed webhook delivery was retried?
      - What happened on each try of a webhook delivery that keeps failing?
      instructions:
      - text: List all delivery attempts for event delivery {eventDeliveryID} in project {projectID}.
        slots:
          eventDeliveryID: path.eventDeliveryID
          projectID: path.projectID
      - text: Show me the retry history of webhook delivery {eventDeliveryID}.
        slots:
          eventDeliveryID: path.eventDeliveryID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/eventdeliveries/{eventDeliveryID}/deliveryattempts/{deliveryAttemptID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a single delivery attempt
      effect: read
      questions:
      - Where can I see the request and response details of one specific webhook delivery attempt?
      - Can I inspect a single retry attempt to find out why the endpoint rejected it?
      instructions:
      - text: Get delivery attempt {deliveryAttemptID} of event delivery {eventDeliveryID} in project {projectID}.
        slots:
          deliveryAttemptID: path.deliveryAttemptID
          eventDeliveryID: path.eventDeliveryID
          projectID: path.projectID
      - text: Show the details of attempt {deliveryAttemptID} so I can see what the endpoint returned.
        slots:
          deliveryAttemptID: path.deliveryAttemptID
      method: generated
      generated: '2026-10-01'