Convoy

Convoy Subscriptions API

Subscription 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

POST /v1/projects/{projectID}/sources/test_function Test a source's transform function on a payload · Validate Source Function #
Ask an LLM
“Can I dry-run the function attached to an incoming source before I save that source?”
“What does an ingest source's function produce from a sample webhook body?”
Tell an agent
Test source function {function} of type {type} against sample payload {payload} in project {projectID}.
Dry-run my incoming source's function {function} in project {projectID} before saving the source.
GET /v1/projects/{projectID}/subscriptions List subscriptions · List All Subscriptions #
Ask an LLM
“Which subscriptions route events to my endpoints?”
“Can I list subscriptions for a particular endpoint or search by name?”
Tell an agent
List subscriptions in project {projectID}.
Show the subscriptions attached to endpoint {endpointId}.
POST /v1/projects/{projectID}/subscriptions Subscribe an endpoint to events · Create a Subscription #
Ask an LLM
“How do I connect an endpoint so it starts receiving events?”
“Can I link a source to an endpoint with its own filter and rate limit?”
Tell an agent
Create subscription {name} for endpoint {endpoint_id} in project {projectID}.
Subscribe endpoint {endpoint_id} to source {source_id}.
POST /v1/projects/{projectID}/subscriptions/test_filter Validate a filter schema against a sample request · Validate Subscription Filter #
Ask an LLM
“Before saving a subscription, would my filter schema match this request?”
“Can I check a draft filter schema against sample headers and body?”
Tell an agent
Validate filter schema {schema} against request {request} in project {projectID}.
Check whether my draft filter {schema} matches this sample request {request}.
POST /v1/projects/{projectID}/subscriptions/test_function Test a payload transform function · Test a Subscription Function #
Ask an LLM
“Can I try my JavaScript transform function on a sample payload first?”
“What will my payload look like after a subscription function mutates it?”
Tell an agent
Run transform function {function} against payload {payload} in project {projectID}.
Test-run this transform {function} on a sample payload and show the output.
DELETE /v1/projects/{projectID}/subscriptions/{subscriptionID} Delete a subscription · Delete Subscription #
Ask an LLM
“How do I stop an endpoint from receiving events by removing its subscription?”
“Can I delete a subscription without deleting the endpoint?”
Tell an agent destructive · confirm first
Delete subscription {subscriptionID} from project {projectID}.
Remove subscription {subscriptionID}.
GET /v1/projects/{projectID}/subscriptions/{subscriptionID} Retrieve a subscription · Retrieve a Subscription #
Ask an LLM
“What endpoint, source and filter does one subscription use?”
“Can I look up a single subscription by its ID?”
Tell an agent
Get subscription {subscriptionID} in project {projectID}.
Show me the settings of subscription {subscriptionID}.
PUT /v1/projects/{projectID}/subscriptions/{subscriptionID} Update a subscription · Update a Subscription #
Ask an LLM
“How do I change the retry policy on an existing subscription?”
“Can I point a subscription I already have at a different endpoint?”
Tell an agent
Set retry config {retry_config} on subscription {subscriptionID} in project {projectID}.
Move existing subscription {subscriptionID} to endpoint {endpoint_id}.

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