Convoy

Convoy Events API

Event related APIs

GitHub OpenAPI
Business capability
Webhook & Event Subscription Management BC-4270.80

Operations 8

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/projects/{projectID}/events List events sent through a project · List All Events #
Ask an LLM
“Which events has my project sent in the past week?”
“Can I search events by a value inside their payload?”
Tell an agent
List events in project {projectID}.
Find events whose payload contains {query} between {startDate} and {endDate}.
POST /v1/projects/{projectID}/events Send an event to one endpoint · Create an Event #
Ask an LLM
“How do I send a webhook event to a single specific endpoint?”
“Can I attach custom headers and an idempotency key to an event for one endpoint?”
Tell an agent
Send a {event_type} event with data {data} to endpoint {endpoint_id} in project {projectID}.
Create an event for endpoint {endpoint_id} with idempotency key {idempotency_key}.
POST /v1/projects/{projectID}/events/batchreplay Replay many events at once · Batch Replay Events #
Ask an LLM
“Can I replay all the events from a date range after an outage?”
“Is there a bulk replay for every event that came from one source?”
Tell an agent
Batch replay all events in project {projectID} from {startDate} to {endDate}.
Replay in bulk every event sent to endpoint {endpointId}.
POST /v1/projects/{projectID}/events/broadcast Broadcast an event to all subscribed endpoints · Create a Broadcast Event #
Ask an LLM
“How do I send one event to every endpoint subscribed to its event type?”
“Can I broadcast an event without naming each endpoint?”
Tell an agent
Broadcast a {event_type} event with data {data} in project {projectID}.
Broadcast {event_type} to all matching subscribers using idempotency key {idempotency_key}.
POST /v1/projects/{projectID}/events/dynamic Send an event to a URL without setup · Dynamic Events #
Ask an LLM
“Can I send a webhook to a URL without creating an endpoint and subscription first?”
“What's the quickest way to deliver a one-off payload to an arbitrary HTTPS URL?”
Tell an agent
Send a dynamic {event_type} event with data {data} straight to {url} in project {projectID}.
Deliver a dynamic event to {url} signed with secret {secret}.
POST /v1/projects/{projectID}/events/fanout Fan out an event to an owner's endpoints · Fan Out an Event #
Ask an LLM
“How do I send one event to all endpoints that share an owner ID?”
“Can a single event fan out to every endpoint a customer has registered?”
Tell an agent
Fan out a {event_type} event with data {data} to owner {owner_id} in project {projectID}.
Send this event to every endpoint owned by {owner_id}.
GET /v1/projects/{projectID}/events/{eventID} Retrieve an event · Retrieve an Event #
Ask an LLM
“Where can I see the payload and type of one event I sent?”
“Can I look up a single event by its ID?”
Tell an agent
Get event {eventID} in project {projectID}.
Show me the payload of event {eventID}.
PUT /v1/projects/{projectID}/events/{eventID}/replay Replay a single event as new · Replay Event #
Ask an LLM
“How do I replay one event as if it were brand new?”
“Can I resend a single past event to its subscribers again?”
Tell an agent
Replay event {eventID} in project {projectID}.
Replay event {eventID} afresh.

Documentation

📖
APIReference
https://getconvoy.io/docs/api-reference/welcome
📖
Documentation
https://getconvoy.io/docs/
📖
Authentication
https://getconvoy.io/docs/api-reference/authentication
📖
GettingStarted
https://getconvoy.io/docs/quickstart

Specifications

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

SDKs

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

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-endpoint-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-delivery-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-delivery-attempt-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-subscription-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-source-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-portal-link-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-schema/convoy-event-type-schema.json

Other Resources

🔗
Regions
https://getconvoy.io/docs
🔗
TermsOfService
https://getconvoy.io/terms
🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./json-ld/convoy-context.jsonld
🔗
SpectralRules
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./rules/convoy-rules.yml
🔗
Vocabulary
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./vocabulary/convoy-vocabulary.yml
🔗
Examples
https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/./examples/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/convoy:convoy-events-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

convoy-events-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: support@getconvoy.io
    name: Convoy Support
    url: https://getconvoy.io/docs
  description: Convoy is a fast and secure webhooks proxy. This document contains datastore's API specification.
  license:
    name: Mozilla Public License 2.0
    url: https://www.mozilla.org/en-US/MPL/2.0/
  termsOfService: https://getconvoy.io/terms
  title: Convoy API Reference Events API
  version: 26.3.5
servers:
- url: https://us.getconvoy.cloud/api
  description: US Region
- url: https://eu.getconvoy.cloud/api
  description: EU Region
tags:


# --- truncated at 32 KB (38 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/openapi/convoy-events-api-openapi.yml