Convoy · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Convoy API Reference Onboard API

2 actions 2 updates phrasing extends openapi/convoy-onboard-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 2

$.info
$.paths['/v1/projects/{projectID}/onboard'].post

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 Onboard API
  version: 1.0.0
extends: openapi/convoy-onboard-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: 1
- target: $.paths['/v1/projects/{projectID}/onboard'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk onboard endpoints with subscriptions
      effect: write
      questions:
      - Can I create many endpoints and their subscriptions from a CSV file?
      - Is there a dry run to validate a bulk onboarding file before anything is created?
      - How do I onboard a list of customer webhook URLs in one request?
      instructions:
      - text: Bulk onboard endpoints with subscriptions into project {projectID} from my CSV.
        slots:
          projectID: path.projectID
      - text: Validate this onboarding file for project {projectID} with dry run set to {dry_run}.
        slots:
          projectID: path.projectID
          dry_run: query.dry_run
      method: generated
      generated: '2026-10-01'