Convoy website screenshot

Convoy

Convoy is an open-source, cloud-native webhooks gateway used to securely ingest, persist, debug, deliver, and manage events. It positions itself as "the complete solution for secure, scalable, and reliable webhook delivery," covering both outbound (sending) and inbound (receiving) webhooks with retries, payload signing, fan-out, rate limiting, message broker ingestion, and customer-facing portals. Convoy is offered as a self-hosted open-source project (Elastic License v2.0, with the OpenAPI spec under MPL 2.0) and a fully managed cloud service in US and EU regions.

Convoy publishes 11 APIs on the APIs.io network, including Delivery Attempts API, Endpoints API, Event Deliveries API, and 8 more. Tagged areas include Webhooks, Webhook Gateway, Event Delivery, Eventing, and Messaging.

The Convoy catalog on APIs.io includes 1 JSON-LD context and 2 Spectral governance rulesets.

Convoy’s developer surface includes authentication, developer portal, documentation, API reference, getting-started guide, signup flow, pricing, and 39 more developer resources.

🌐 Visit website 📡 Source on GitHub
63.4/100 strong ▼ -10.2 Agent 37/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessFreemiumSelf serve⚡ Free to try
11 APIs 5 Features 5 Use Cases
WebhooksWebhook GatewayEvent DeliveryEventingMessagingIntegrationAPI Infrastructure

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 63.4/100 · strong
Contract Quality 19.3 / 25
Developer Ergonomics 15.7 / 20
Commercial Clarity 14.2 / 20
Operational Transparency 6.2 / 13
Governance 7.0 / 12
Discoverability 6.9 / 10
Agent readiness — 37/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 7 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 0 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 4 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/convoy: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 11

Individual APIs this provider publishes, each with its own machine-readable definition.

Convoy Delivery Attempts API

Delivery Attempt related APIs

Convoy Endpoints API

Endpoint related APIs

Convoy Event Deliveries API

EventDelivery related APIs

Convoy Events API

Event related APIs

Convoy EventTypes API

Event Types related APIs

Convoy Filters API

Filters related APIs

Convoy Meta Events API

Meta Events related APIs

Convoy Onboard API

Onboard related APIs

Convoy Portal Links API

Portal Links related APIs

Convoy Sources API

Source related APIs

Convoy Subscriptions API

Subscription related APIs

Scroll for all 11

Postman Collections 1

Ready-to-run Postman collections for exercising this provider's APIs.

Convoy API Reference

POSTMAN

Open Collections 1

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

Convoy API Reference

OPEN COLLECTION

Arazzo Workflows 12

Multi-step API workflows described with the Arazzo specification.

Convoy Attach Filter to Subscription

Create a subscription, attach a body-matching filter, and confirm the filter list.

ARAZZO

Convoy Batch Retry Failed Deliveries

Detect failed deliveries for an endpoint and batch retry them in one call.

ARAZZO

Convoy Broadcast Event and Track

Broadcast an event to all matching subscriptions and trace the resulting event.

ARAZZO

Convoy Create Event and Trace Delivery

Publish an event to an endpoint, find its delivery, and read the delivery attempts.

ARAZZO

Convoy Define Event Type and Subscribe

Define a project event type, create an endpoint, and subscribe filtered to that type.

ARAZZO

Convoy Fan Out Event to Owner

Confirm endpoints exist for an owner, fan out an event to them, and verify it landed.

ARAZZO

Convoy Force Resend Successful Deliveries

Find a recent successful delivery for an endpoint and force resend it by ID.

ARAZZO

Convoy Inspect Delivery Attempts

Retrieve an event delivery, list its attempts, and drill into a single attempt.

ARAZZO

Convoy Provision Endpoint and Subscription

Stand up a webhook endpoint, subscribe it, send a first event, and confirm delivery.

ARAZZO

Convoy Register Incoming Source

Create an HMAC-verified incoming source and subscribe it to an endpoint.

ARAZZO

Convoy Replay Event

Pick a recent event, replay it as a fresh event, and trace the new deliveries.

ARAZZO

Convoy Retry a Failed Delivery

Find a failed event delivery, retry it, and inspect the resulting delivery attempts.

ARAZZO

Scroll for all 12

Pricing Plans 1

Published pricing tiers and plan structures.

Convoy Plans Pricing

3 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Convoy Rate Limits

0 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Convoy Finops

FINOPS

Features 5

Notable capabilities this provider offers.

GitHub
Shopify
Twitter/X
Mono
Generic HTTP (HMAC, Basic Auth, API Key, or Custom verification)

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Convoy Context

48 classes · 10 properties

JSON-LD

Spectral Rules 2

Spectral governance rulesets for linting and validating these APIs.

Convoy API Rules

5 rules · 4 warnings 1 info

SPECTRAL

Convoy API Rules

14 rules · 6 errors 5 warnings

SPECTRAL

JSON Schema 8

Standalone JSON Schema definitions for this provider's data models.

Convoy DeliveryAttempt

17 properties

JSON SCHEMA

Convoy Endpoint

22 properties

JSON SCHEMA

Convoy EventDelivery

25 properties

JSON SCHEMA

Convoy Event

20 properties

JSON SCHEMA

Convoy EventType

6 properties

JSON SCHEMA

Convoy PortalLink

15 properties

JSON SCHEMA

Convoy Source

19 properties

JSON SCHEMA

Convoy Subscription

16 properties

JSON SCHEMA

Scroll for all 8

JSON Structure 8

JSON Structure definitions describing this provider's data shapes.

Convoy Delivery Attempt Structure

17 properties

JSON STRUCTURE

Convoy Endpoint Structure

22 properties

JSON STRUCTURE

Convoy Event Delivery Structure

25 properties

JSON STRUCTURE

Convoy Event Structure

20 properties

JSON STRUCTURE

Convoy Event Type Structure

6 properties

JSON STRUCTURE

Convoy Portal Link Structure

15 properties

JSON STRUCTURE

Convoy Source Structure

19 properties

JSON STRUCTURE

Convoy Subscription Structure

16 properties

JSON STRUCTURE

Scroll for all 8

Examples 68

Example request and response payloads for these APIs.

Convoy Delivery Attempt Example

14 fields

EXAMPLE

Convoy Endpoint Example

15 fields

EXAMPLE

Convoy Event Delivery Example

9 fields

EXAMPLE

Convoy Event Example

8 fields

EXAMPLE

Convoy Event Type Example

8 fields

EXAMPLE

Convoy Op Activateendpoint Example

4 fields

EXAMPLE

Convoy Op Batchreplayevents Example

4 fields

EXAMPLE

Convoy Op Batchretryeventdelivery Example

4 fields

EXAMPLE

Convoy Op Bulkcreatefilters Example

4 fields

EXAMPLE

Convoy Op Bulkonboard Example

4 fields

EXAMPLE

Convoy Op Bulkupdatefilters Example

4 fields

EXAMPLE

Convoy Op Createbroadcastevent Example

4 fields

EXAMPLE

Convoy Op Createdynamicevent Example

4 fields

EXAMPLE

Convoy Op Createendpoint Example

4 fields

EXAMPLE

Convoy Op Createendpointevent Example

4 fields

EXAMPLE

Convoy Op Createendpointfanoutevent Example

4 fields

EXAMPLE

Convoy Op Createeventtype Example

4 fields

EXAMPLE

Convoy Op Createfilter Example

4 fields

EXAMPLE

Convoy Op Createportallink Example

4 fields

EXAMPLE

Convoy Op Createsource Example

4 fields

EXAMPLE

Convoy Op Createsubscription Example

4 fields

EXAMPLE

Convoy Op Deleteendpoint Example

4 fields

EXAMPLE

Convoy Op Deletefilter Example

4 fields

EXAMPLE

Convoy Op Deletesource Example

4 fields

EXAMPLE

Convoy Op Deletesubscription Example

4 fields

EXAMPLE

Convoy Op Deprecateeventtype Example

4 fields

EXAMPLE

Convoy Op Expiresecret Example

4 fields

EXAMPLE

Convoy Op Forceresendeventdeliveries Example

4 fields

EXAMPLE

Convoy Op Getdeliveryattempt Example

4 fields

EXAMPLE

Convoy Op Getdeliveryattempts Example

4 fields

EXAMPLE

Convoy Op Getendpoint Example

4 fields

EXAMPLE

Convoy Op Getendpointevent Example

4 fields

EXAMPLE

Convoy Op Getendpoints Example

4 fields

EXAMPLE

Convoy Op Geteventdeliveriespaged Example

4 fields

EXAMPLE

Convoy Op Geteventdelivery Example

4 fields

EXAMPLE

Convoy Op Geteventspaged Example

4 fields

EXAMPLE

Convoy Op Geteventtypes Example

4 fields

EXAMPLE

Convoy Op Getfilter Example

4 fields

EXAMPLE

Convoy Op Getfilters Example

4 fields

EXAMPLE

Convoy Op Getmetaevent Example

4 fields

EXAMPLE

Convoy Op Getmetaeventspaged Example

4 fields

EXAMPLE

Convoy Op Getportallink Example

4 fields

EXAMPLE

Convoy Op Getsource Example

4 fields

EXAMPLE

Convoy Op Getsubscription Example

4 fields

EXAMPLE

Convoy Op Getsubscriptions Example

4 fields

EXAMPLE

Convoy Op Importopenapispec Example

4 fields

EXAMPLE

Convoy Op Loadportallinkspaged Example

4 fields

EXAMPLE

Convoy Op Loadsourcespaged Example

4 fields

EXAMPLE

Convoy Op Pauseendpoint Example

4 fields

EXAMPLE

Convoy Op Post V1 Projects Projectid Sources Test Function Example

4 fields

EXAMPLE

Convoy Op Refreshportallinkauthtoken Example

4 fields

EXAMPLE

Convoy Op Replayendpointevent Example

4 fields

EXAMPLE

Convoy Op Resendeventdelivery Example

4 fields

EXAMPLE

Convoy Op Resendmetaevent Example

4 fields

EXAMPLE

Convoy Op Revokeportallink Example

4 fields

EXAMPLE

Convoy Op Testfilter Example

4 fields

EXAMPLE

Convoy Op Testoauth2Connection Example

4 fields

EXAMPLE

Convoy Op Testsubscriptionfilter Example

4 fields

EXAMPLE

Convoy Op Testsubscriptionfunction Example

4 fields

EXAMPLE

Convoy Op Updateendpoint Example

4 fields

EXAMPLE

Convoy Op Updateeventtype Example

4 fields

EXAMPLE

Convoy Op Updatefilter Example

4 fields

EXAMPLE

Convoy Op Updateportallink Example

4 fields

EXAMPLE

Convoy Op Updatesource Example

4 fields

EXAMPLE

Convoy Op Updatesubscription Example

4 fields

EXAMPLE

Convoy Portal Link Example

11 fields

EXAMPLE

Convoy Source Example

9 fields

EXAMPLE

Convoy Subscription Example

11 fields

EXAMPLE

Scroll for all 68

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Convoy Authentication

apiKey · 1 scheme

SECURITY

Convoy Domain Security

TLSv1.3 · HSTS · DMARC

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Convoy Agentic Access

60 operations · 40 acting · 1 human-in-the-loop

60 operations · 40 acting

AGENTIC

Use Cases 5

What developers build with this provider.

Webhook gateway between microservices and external consumers
Receiving webhooks from third-party providers and routing to internal services
Replacing in-house retry/signing/observability code for webhooks
Customer-facing webhook dashboards via embeddable portal links
Bridging message brokers to HTTP endpoints

Resources

Get Started 5

Portal, sign-up, and the first successful call

Portal
Portal
 DeveloperPortal
DeveloperPortal
 GettingStarted
GettingStarted
 Signup
Signup
 Login
Login

Documentation 2

Reference material describing how the API behaves

Documentation
Documentation
 APIReference
APIReference

Agent Surfaces 2

MCP servers, agent skills, and machine-readable catalogs

AgenticAccess
AgenticAccess
 LlmsText
LlmsText

Design & Contract 12

Pagination, idempotency, versioning, errors, and events

Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo
 Arazzo
Arazzo

Scroll for all 12

Build 13

SDKs, sample code, and the tooling you integrate with

PostmanWorkspace
PostmanWorkspace
 GitHubOrganization
GitHubOrganization
 GitHubRepository
GitHubRepository
 SDKs
SDKs
 SDKs
SDKs
 SDKs
SDKs
 SDKs
SDKs
 SDKs
SDKs
 CLI
CLI
 CLI
CLI
 CodeExamples
CodeExamples
 CodeExamples
CodeExamples
 CodeExamples
CodeExamples

Scroll for all 13

Access & Security 4

Authentication, authorization, and security posture

DomainSecurity
DomainSecurity
 Authentication
Authentication
 Security
Security
 Compliance
Compliance

Operate 5

Status, limits, changes, and where to get help

RateLimits
RateLimits
 ChangeLog
ChangeLog
 StatusPage
StatusPage
 Support
Support
 Contact
Contact

Commercial 2

Pricing, plans, and the legal terms of use

Pricing
Pricing
 Plans
Plans

Company 1

The organization behind the API

Blog
Blog

Other 2

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑ 
name: Convoy
description: Convoy is an open-source, cloud-native webhooks gateway used to securely ingest, persist, debug, deliver, and
  manage events. It positions itself as "the complete solution for secure, scalable, and reliable webhook delivery," covering
  both outbound (sending) and inbound (receiving) webhooks with retries, payload signing, fan-out, rate limiting, message
  broker ingestion, and customer-facing portals. Convoy is offered as a self-hosted open-source project (Elastic License v2.0,
  with the OpenAPI spec under MPL 2.0) and a fully managed cloud service in US and EU regions.
url: https://github.com/api-evangelist/convoy
humanURL: https://getconvoy.io
baseURL: https://us.getconvoy.cloud/api
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  label: Freemium · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://avatars.githubusercontent.com/u/64033435?s=200&v=4
created: '2026-05-22'
modified: '2026-05-22'
specificationVersion: '0.18'
type: Index
aid: convoy
tags:
- Webhooks
- Webhook Gateway
- Event Delivery
- Eventing
- Messaging
- Integration
- API Infrastructure
apis:
- aid: convoy:convoy-delivery-attempts-api
  name: Convoy Delivery Attempts API
  description: Delivery Attempt related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Delivery Attempts
  properties:
  - type: OpenAPI
    url: openapi/convoy-delivery-attempts-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-endpoints-api
  name: Convoy Endpoints API
  description: Endpoint related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Endpoints
  properties:
  - type: OpenAPI
    url: openapi/convoy-endpoints-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-event-deliveries-api
  name: Convoy Event Deliveries API
  description: EventDelivery related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Event Deliveries
  properties:
  - type: OpenAPI
    url: openapi/convoy-event-deliveries-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-events-api
  name: Convoy Events API
  description: Event related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Events
  properties:
  - type: OpenAPI
    url: openapi/convoy-events-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-eventtypes-api
  name: Convoy EventTypes API
  description: Event Types related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - EventTypes
  properties:
  - type: OpenAPI
    url: openapi/convoy-eventtypes-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-filters-api
  name: Convoy Filters API
  description: Filters related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Filters
  properties:
  - type: OpenAPI
    url: openapi/convoy-filters-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-meta-events-api
  name: Convoy Meta Events API
  description: Meta Events related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Meta Events
  properties:
  - type: OpenAPI
    url: openapi/convoy-meta-events-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-onboard-api
  name: Convoy Onboard API
  description: Onboard related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Onboard
  properties:
  - type: OpenAPI
    url: openapi/convoy-onboard-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-portal-links-api
  name: Convoy Portal Links API
  description: Portal Links related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Portal Links
  properties:
  - type: OpenAPI
    url: openapi/convoy-portal-links-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-sources-api
  name: Convoy Sources API
  description: Source related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Sources
  properties:
  - type: OpenAPI
    url: openapi/convoy-sources-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
- aid: convoy:convoy-subscriptions-api
  name: Convoy Subscriptions API
  description: Subscription related APIs
  humanURL: https://getconvoy.io/docs/api-reference/welcome
  baseURL: https://us.getconvoy.cloud/api
  tags:
  - Subscriptions
  properties:
  - type: OpenAPI
    url: openapi/convoy-subscriptions-api-openapi.yml
  - type: APIReference
    url: https://getconvoy.io/docs/api-reference/welcome
  - type: Documentation
    url: https://getconvoy.io/docs/
  - type: Authentication
    url: https://getconvoy.io/docs/api-reference/authentication
  - type: GettingStarted
    url: https://getconvoy.io/docs/quickstart
  - type: Regions
    url: https://getconvoy.io/docs
  - type: GitHubRepository
    url: https://github.com/frain-dev/convoy
  - type: TermsOfService
    url: https://getconvoy.io/terms
  - type: JSONSchema
    url: ./json-schema/convoy-endpoint-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-delivery-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-delivery-attempt-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-subscription-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-source-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-portal-link-schema.json
  - type: JSONSchema
    url: ./json-schema/convoy-event-type-schema.json
  - type: JSONLD
    url: ./json-ld/convoy-context.jsonld
  - type: SpectralRules
    url: ./rules/convoy-rules.yml
  - type: Vocabulary
    url: ./vocabulary/convoy-vocabulary.yml
  - type: Examples
    url: ./examples/
common:
- type: AgenticAccess
  url: agentic-access/convoy-agentic-access.yml
- type: DomainSecurity
  url: security/convoy-domain-security.yml
- type: Authentication
  url: authentication/convoy-authentication.yml
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/convoy/overview
- type: Arazzo
  url: arazzo/convoy-attach-filter-to-subscription-workflow.yml
  name: Convoy Attach Filter to Subscription
- type: Arazzo
  url: arazzo/convoy-batch-retry-failed-deliveries-workflow.yml
  name: Convoy Batch Retry Failed Deliveries
- type: Arazzo
  url: arazzo/convoy-broadcast-event-and-track-workflow.yml
  name: Convoy Broadcast Event and Track
- type: Arazzo
  url: arazzo/convoy-create-event-and-trace-delivery-workflow.yml
  name: Convoy Create Event and Trace Delivery
- type: Arazzo
  url: arazzo/convoy-define-event-type-and-subscribe-workflow.yml
  name: Convoy Define Event Type and Subscribe
- type: Arazzo
  url: arazzo/convoy-fanout-event-to-owner-workflow.yml
  name: Convoy Fan Out Event to Owner
- type: Arazzo
  url: arazzo/convoy-force-resend-deliveries-workflow.yml
  name: Convoy Force Resend Successful Deliveries
- type: Arazzo
  url: arazzo/convoy-inspect-delivery-attempts-workflow.yml
  name: Convoy Inspect Delivery Attempts
- type: Arazzo
  url: arazzo/convoy-provision-endpoint-subscription-workflow.yml
  name: Convoy Provision Endpoint and Subscription
- type: Arazzo
  url: arazzo/convoy-register-incoming-source-workflow.yml
  name: Convoy Register Incoming Source
- type: Arazzo
  url: arazzo/convoy-replay-event-workflow.yml
  name: Convoy Replay Event
- type: Arazzo
  url: arazzo/convoy-retry-failed-delivery-workflow.yml
  name: Convoy Retry a Failed Delivery
- type: Portal
  url: https://getconvoy.io
- type: DeveloperPortal
  url: https://getconvoy.io/docs/
- type: Documentation
  url: https://getconvoy.io/docs/
- type: APIReference
  url: https://getconvoy.io/docs/api-reference/welcome
- type: GettingStarted
  url: https://getconvoy.io/docs/quickstart
- type: Signup
  url: https://dashboard.getconvoy.io/signup
- type: Login
  url: https://dashboard.getconvoy.io/login
- type: Pricing
  url: https://getconvoy.io/pricing
- type: Plans
  url: ./plans/convoy-plans-pricing.yml
- type: RateLimits
  url: ./rate-limits/convoy-rate-limits.yml
- type: ChangeLog
  url: https://getconvoy.io/changelog
- type: Blog
  url: https://getconvoy.io/blog
- type: StatusPage
  url: https://status.getconvoy.io
- type: Security
  url: https://getconvoy.io/docs/product-manual/signatures
- type: Compliance
  url: https://getconvoy.io/pricing
- type: Support
  url: mailto:support@getconvoy.io
- type: Contact
  url: https://getconvoy.io
- type: GitHubOrganization
  url: https://github.com/frain-dev
- type: GitHubRepository
  name: convoy
  url: https://github.com/frain-dev/convoy
  description: The Cloud Native Webhooks Gateway (Go, Elastic License v2.0, 2,805+ stars).
- type: SDKs
  name: convoy-go
  url: https://github.com/frain-dev/convoy-go
  description: Official Go SDK for Convoy.
- type: SDKs
  name: convoy.js
  url: https://github.com/frain-dev/convoy.js
  description: Official JavaScript/TypeScript SDK for Convoy.
- type: SDKs
  name: convoy-python
  url: https://github.com/frain-dev/convoy-python
  description: Official Python SDK for Convoy.
- type: SDKs
  name: convoy-php
  url: https://github.com/frain-dev/convoy-php
  description: Official PHP SDK for Convoy.
- type: SDKs
  name: convoy.rb
  url: https://github.com/frain-dev/convoy.rb
  description: Official Ruby SDK for Convoy.
- type: CLI
  name: convoy-cli
  url: https://github.com/frain-dev/convoy-cli
  description: CLI tool for debugging Convoy webhook events locally.
- type: CLI
  name: homebrew-tools
  url: https://github.com/frain-dev/homebrew-tools
  description: Homebrew formulas for installing Frain/Convoy binaries.
- type: Integrations
  name: Helm Charts
  url: https://github.com/frain-dev/helm-charts
  description: Official Kubernetes Helm charts for deploying Convoy.
- type: Integrations
  name: Prometheus + Grafana Dashboards
  url: https://github.com/frain-dev/prometheus-grafana-dashboard
  description: Docker-compose plus Grafana dashboards for observing Convoy queue and consumer metrics.
- type: Integrations
  name: Convoy Ingester
  url: https://github.com/frain-dev/convoy-ingester
  description: Serverless function for accepting incoming webhooks into Convoy.
- type: CodeExamples
  name: convoy-playground
  url: https://github.com/frain-dev/convoy-playground
  description: Example/demo environment for Convoy.
- type: CodeExamples
  name: webhooks-with-kafka-demo
  url: https://github.com/frain-dev/webhooks-with-kafka-demo
  description: Demo showing webhook ingestion from Kafka via Convoy.
- type: CodeExamples
  name: convoy-paystack
  url: https://github.com/frain-dev/convoy-paystack
  description: Artifacts for the Paystack webinar on webhooks with Convoy.
- type: Features
  title: Core Capabilities
  data:
  - Outbound (sending) webhook delivery
  - Inbound (receiving) webhook ingestion
  - HMAC payload signing (simple and advanced/timestamped signatures, hex or base64 encoding)
  - Retry strategies (linear / constant time and exponential backoff with jitter)
  - Batch retries and force-resend
  - Fan-out routing by event type or payload structure
  - Per-endpoint rate limiting
  - Endpoint circuit breaking and pause/activate
  - Rolling endpoint secrets
  - Static IPs for restricted network environments (Cloud add-on)
  - mTLS client certificate support for endpoints
  - Webhook transformations with JavaScript
  - Customer-facing dashboards via Portal Links (iframe embeddable)
  - Email and Slack notifications for endpoint failures
  - OAuth2 (client credentials, JWT client assertion) for outbound auth
- type: Features
  title: Message Broker Ingest
  data:
  - Apache Kafka
  - Google Cloud Pub/Sub
  - AWS SQS
  - RabbitMQ (AMQP)
- type: Features
  title: Source Provider Types
  data:
  - GitHub
  - Shopify
  - Twitter/X
  - Mono
  - Generic HTTP (HMAC, Basic Auth, API Key, or Custom verification)
- type: Regions
  data:
  - US (https://us.getconvoy.cloud/api)
  - EU (https://eu.getconvoy.cloud/api)
- type: UseCases
  data:
  - Webhook gateway between microservices and external consumers
  - Receiving webhooks from third-party providers and routing to internal services
  - Replacing in-house retry/signing/observability code for webhooks
  - Customer-facing webhook dashboards via embeddable portal links
  - Bridging message brokers to HTTP endpoints
- type: Customers
  data:
  - Neynar
  - Spruce Health
  - Marble
  - Source.ag
  - Maple
  - Mono
  - Xendit
- type: LlmsText
  url: https://eu.getconvoy.cloud/llms.txt