Convoy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Convoy API Reference Meta Events API

4 actions 4 updates phrasing extends openapi/convoy-meta-events-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 4

$.info
$.paths['/v1/projects/{projectID}/meta-events'].get
$.paths['/v1/projects/{projectID}/meta-events/{metaEventID}'].get
$.paths['/v1/projects/{projectID}/meta-events/{metaEventID}/resend'].put

OpenAPI Overlay

Raw ↑ 
# 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 Meta Events API
  version: 1.0.0
extends: openapi/convoy-meta-events-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: 3
- target: $.paths['/v1/projects/{projectID}/meta-events'].get
  update:
    x-apievangelist-phrasing:
      intent: List a project's meta events
      effect: read
      questions:
      - Which meta events about my Convoy project's own activity were sent recently?
      - Can I page through meta events within a date range?
      instructions:
      - text: List meta events in project {projectID}.
        slots:
          projectID: path.projectID
      - text: Show meta events from {startDate} to {endDate}.
        slots:
          startDate: query.startDate
          endDate: query.endDate
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/meta-events/{metaEventID}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a meta event
      effect: read
      questions:
      - Where do I see the details of one meta event?
      - Did a specific meta event get delivered successfully?
      instructions:
      - text: Get meta event {metaEventID} in project {projectID}.
        slots:
          metaEventID: path.metaEventID
          projectID: path.projectID
      - text: Show me meta event {metaEventID}.
        slots:
          metaEventID: path.metaEventID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/projects/{projectID}/meta-events/{metaEventID}/resend'].put
  update:
    x-apievangelist-phrasing:
      intent: Retry a meta event
      effect: write
      questions:
      - How do I retry a meta event that failed to deliver?
      - Can I resend a single meta event manually?
      instructions:
      - text: Retry meta event {metaEventID} in project {projectID}.
        slots:
          metaEventID: path.metaEventID
          projectID: path.projectID
      - text: Resend meta event {metaEventID}.
        slots:
          metaEventID: path.metaEventID
      method: generated
      generated: '2026-10-01'