How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Convoy Subscriptions API

Subscription related APIs

Convoy Subscriptions API is one of 11 APIs that Convoy publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 8 JSON Schema definitions.

Tagged areas include Subscription. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, authentication docs, a getting-started guide, a GitHub repository, and 8 JSON Schemas.

This API exposes 8 operations across 5 paths, and defines 58 schemas. It is described by OpenAPI 3.2.0, at version 26.3.5.

Requests are made against 2 base URLs: https://us.getconvoy.cloud/api, https://eu.getconvoy.cloud/api.

8 operations 5 paths 58 schemas 1 DELETE2 GET4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
26.3.5
Base URL
https://us.getconvoy.cloud/api
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Convoy Subscriptions API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth).

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 2 GET, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Subscriptions 8

Subscription related APIs

POST
/v1/projects/{projectID}/sources/test_function
Validate Source Function
1 param body → 200400401404
GET
/v1/projects/{projectID}/subscriptions
List All Subscriptions
GetSubscriptions 8 params → 200400401404
POST
/v1/projects/{projectID}/subscriptions
Create a Subscription
CreateSubscription 1 param body → 201400401404
POST
/v1/projects/{projectID}/subscriptions/test_filter
Validate Subscription Filter
TestSubscriptionFilter 1 param body → 200400401404
POST
/v1/projects/{projectID}/subscriptions/test_function
Test a Subscription Function
TestSubscriptionFunction 1 param body → 200400401404
DELETE
/v1/projects/{projectID}/subscriptions/{subscriptionID}
Delete Subscription
DeleteSubscription 2 params → 200400401404
GET
/v1/projects/{projectID}/subscriptions/{subscriptionID}
Retrieve a Subscription
GetSubscription 2 params → 200400401404
PUT
/v1/projects/{projectID}/subscriptions/{subscriptionID}
Update a Subscription
UpdateSubscription 2 params body → 202400401404

Schemas 58

The contract defines 58 schemas that model the data the API accepts and returns. The most detailed are datastore.Endpoint (22 properties), datastore.Source (19 properties), models.SubscriptionResponse (16 properties), datastore.OAuth2SigningKey (13 properties). Each schema is shown below with its type and property counts.

datastore.KafkaPubSubConfig
object
4 properties
datastore.SourceProvider
string
datastore.Source
object
19 properties
datastore.EndpointAuthenticationType
string
models.PagedResponse
object
2 properties
datastore.CustomResponse
object
2 properties
datastore.FilterSchema
object
3 properties
datastore.PaginationData
object
5 properties
datastore.BasicAuth
object
2 properties
models.SubscriptionResponse
object
16 properties
datastore.GooglePubSubConfig
object
3 properties
datastore.EndpointAuthentication
object
4 properties
datastore.SubscriptionType
string
datastore.StrategyProvider
string
datastore.SourceType
string
datastore.DeliveryMode
string
handlers.Stub
object
models.CreateSubscription
object
9 properties
datastore.EndpointStatus
string
datastore.ApiKey
object
2 properties
models.FilterConfiguration
object
2 properties
models.UpdateSubscription
object
10 properties
models.RateLimitConfiguration
object
2 properties
datastore.SQSPubSubConfig
object
5 properties
models.FilterSchema
object
2 properties
datastore.TwitterProviderConfig
object
1 property
datastore.FilterConfiguration
object
2 properties
models.FunctionRequest
object
3 properties
datastore.AlertConfiguration
object
2 properties
datastore.PubSubConfig
object
6 properties
datastore.M
object
datastore.Device
object
9 properties
util.ServerResponse
object
2 properties
models.TestFilter
object
2 properties
models.RetryConfiguration
object
4 properties
datastore.OAuth2
object
13 properties
datastore.PubSubType
string
datastore.OAuth2SigningKey
object
13 properties
datastore.RateLimitConfiguration
object
2 properties
datastore.VerifierType
string
datastore.MtlsClientCert
object
2 properties
datastore.OAuth2ExpiryTimeUnit
string
datastore.KafkaAuth
object
5 properties
models.FunctionResponse
object
2 properties
datastore.RetryConfiguration
object
3 properties
models.AlertConfiguration
object
2 properties
datastore.HMac
object
4 properties
datastore.OAuth2FieldMapping
object
3 properties
datastore.VerifierConfig
object
4 properties
datastore.AmqpPubSubConfig
object
9 properties
datastore.Endpoint
object
22 properties
datastore.DeviceStatus
string
datastore.OAuth2AuthenticationType
string
datastore.ProviderConfig
object
1 property
datastore.Secret
object
6 properties
datastore.AmqpCredentials
object
2 properties
datastore.EncodingType
string
models.FS
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convoy-subscriptions-api-openapi.yml Raw ↑

Other APIs Convoy publishes across the network.

Convoy Delivery Attempts API
Convoy Endpoints API
Convoy Event Deliveries API
Convoy Events API
Convoy EventTypes API
Convoy Filters API
Convoy Meta Events API
Convoy Onboard API
Convoy Portal Links API
Convoy Sources API
Where this information came from

This is an independent, third-party profile of Convoy Subscriptions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.