Convoy

Convoy API

The Convoy REST API, version 26.3.5, exposes 44 operations across 11 resource groups for managing webhook delivery infrastructure: Subscriptions, Endpoints, Events, Sources, Event Deliveries, Delivery Attempts, Portal Links, Meta Events, Event Types, Filters, and Onboard. All operations are scoped to a project (`/v1/projects/{projectID}/...`) and authenticated via Bearer API key in the Authorization header. The managed cloud is split into independently-deployed US and EU regions.

Documentation GitHub OpenAPI

Documentation

https://getconvoy.io/docs/api-reference/welcome

https://getconvoy.io/docs/

https://getconvoy.io/docs/api-reference/authentication

https://getconvoy.io/docs/quickstart

Specifications

https://raw.githubusercontent.com/frain-dev/convoy/main/docs/v3/openapi3.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./openapi/convoy-openapi.yml

SDKs

GitHubRepository

https://github.com/frain-dev/convoy

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-endpoint-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-delivery-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-delivery-attempt-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-subscription-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-source-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-portal-link-schema.json

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-type-schema.json

Other Resources

https://getconvoy.io/docs

https://getconvoy.io/terms

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-ld/convoy-context.jsonld

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./rules/convoy-rules.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./vocabulary/convoy-vocabulary.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./examples/

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/apis.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-attach-filter-to-subscription-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-batch-retry-failed-deliveries-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-broadcast-event-and-track-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-create-event-and-trace-delivery-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-define-event-type-and-subscribe-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-fanout-event-to-owner-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-force-resend-deliveries-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-inspect-delivery-attempts-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-provision-endpoint-subscription-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-register-incoming-source-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-replay-event-workflow.yml

https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/arazzo/convoy-retry-failed-delivery-workflow.yml

OpenAPI Specification