Convoy

Convoy Endpoints API

Endpoint related APIs

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

Operations 9

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}/endpoints List webhook endpoints in a project · List All Endpoints #
Ask an LLM
“Which webhook endpoints are registered in my Convoy project?”
“Can I filter my endpoints by owner ID to see a fanout group?”
Tell an agent
List all endpoints in project {projectID}.
Find endpoints named {q} in project {projectID}.
POST /v1/projects/{projectID}/endpoints Register a new webhook endpoint · Create an Endpoint #
Ask an LLM
“How do I add a new HTTPS URL that should receive my webhooks?”
“Can I set a rate limit and HTTP timeout when registering an endpoint?”
Tell an agent
Create an endpoint named {name} pointing at {url} in project {projectID}.
Register a new endpoint for {url} with support email {support_email} and owner {owner_id}.
POST /v1/projects/{projectID}/endpoints/oauth2/test Test an endpoint's OAuth2 token exchange · Test OAuth2 Connection #
Ask an LLM
“Can I check that my OAuth2 client credentials work before attaching them to an endpoint?”
“Is there a way to verify Convoy can exchange a token with my OAuth2 server?”
Tell an agent
Test the OAuth2 connection {oauth2} for project {projectID}.
Try a token exchange with these OAuth2 settings {oauth2} and tell me if it succeeds.
DELETE /v1/projects/{projectID}/endpoints/{endpointID} Delete a webhook endpoint · Delete Endpoint #
Ask an LLM
“How do I permanently remove an endpoint that no longer needs webhooks?”
“Can I delete an endpoint rather than just pausing it?”
Tell an agent destructive · confirm first
Delete endpoint {endpointID} from project {projectID}.
Remove endpoint {endpointID} permanently.
GET /v1/projects/{projectID}/endpoints/{endpointID} Retrieve a webhook endpoint's details · Retrieve Endpoint #
Ask an LLM
“How do I look up the configuration of one specific endpoint?”
“What URL, status and rate limit is a given endpoint currently set to?”
Tell an agent
Get endpoint {endpointID} in project {projectID}.
Show me the current settings of endpoint {endpointID}.
PUT /v1/projects/{projectID}/endpoints/{endpointID} Update an existing webhook endpoint · Update an Endpoint #
Ask an LLM
“Can I change the URL an existing endpoint delivers webhooks to?”
“How do I update the support email or Slack alert URL on an endpoint I already created?”
Tell an agent
Change the URL of endpoint {endpointID} in project {projectID} to {url}.
Update existing endpoint {endpointID} to send failure alerts to {slack_webhook_url}.
POST /v1/projects/{projectID}/endpoints/{endpointID}/activate Reactivate an inactive endpoint · Activate Endpoint #
Ask an LLM
“An endpoint was marked inactive after failures, how do I turn it back on?”
“Can I reactivate a disabled endpoint so it starts receiving webhooks again?”
Tell an agent
Activate inactive endpoint {endpointID} in project {projectID}.
Bring endpoint {endpointID} back from inactive status.
PUT /v1/projects/{projectID}/endpoints/{endpointID}/expire_secret Roll an endpoint's signing secret · Roll Endpoint Secret #
Ask an LLM
“How do I rotate the webhook signing secret for an endpoint?”
“Can I keep the old endpoint secret valid for a while after rolling a new one?”
Tell an agent destructive · confirm first
Roll the secret for endpoint {endpointID} in project {projectID}.
Expire the old secret on endpoint {endpointID} after {expiration} and set the new secret to {secret}.
PUT /v1/projects/{projectID}/endpoints/{endpointID}/pause Pause or unpause an endpoint · Pause Endpoint #
Ask an LLM
“Can I temporarily stop webhooks going to an endpoint during maintenance?”
“Is there a toggle to switch an endpoint between active and paused?”
Tell an agent
Pause endpoint {endpointID} in project {projectID}.
Toggle the paused state of endpoint {endpointID} so deliveries resume.

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-endpoints-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-endpoints-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-endpoints-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 Endpoints 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 (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/convoy/refs/heads/main/openapi/convoy-endpoints-api-openapi.yml