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 Sources API

Source related APIs

Convoy Sources 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 Sources. 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 5 operations across 2 paths, and defines 40 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.

5 operations 2 paths 40 schemas 1 DELETE2 GET1 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 Sources API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth).

Paths & Operations 5

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

Sources 5

Source related APIs

GET
/v1/projects/{projectID}/sources
List All Sources
LoadSourcesPaged 8 params → 200400401404
POST
/v1/projects/{projectID}/sources
Create a Source
CreateSource 1 param body → 201400401404
DELETE
/v1/projects/{projectID}/sources/{sourceID}
Delete a Source
DeleteSource 2 params → 200400401404
GET
/v1/projects/{projectID}/sources/{sourceID}
Retrieve a Source
GetSource 2 params → 200400401404
PUT
/v1/projects/{projectID}/sources/{sourceID}
Update a Source
UpdateSource 2 params body → 202400401404

Schemas 40

The contract defines 40 schemas that model the data the API accepts and returns. The most detailed are models.SourceResponse (19 properties), models.UpdateSource (10 properties), models.CreateSource (9 properties), datastore.AmqpPubSubConfig (9 properties). Each schema is shown below with its type and property counts.

datastore.KafkaPubSubConfig
object
4 properties
datastore.SourceProvider
string
models.ApiKey
object
2 properties 2 required
models.PagedResponse
object
2 properties
datastore.CustomResponse
object
2 properties
datastore.PaginationData
object
5 properties
models.AmqpExchange
object
2 properties
datastore.BasicAuth
object
2 properties
datastore.GooglePubSubConfig
object
3 properties
models.GooglePubSubConfig
object
3 properties
models.KafkaAuth
object
5 properties
models.CreateSource
object
9 properties
datastore.SourceType
string
handlers.Stub
object
models.BasicAuth
object
2 properties 2 required
models.UpdateCustomResponse
object
2 properties
datastore.ApiKey
object
2 properties
datastore.SQSPubSubConfig
object
5 properties
datastore.TwitterProviderConfig
object
1 property
models.VerifierConfig
object
4 properties 1 required
datastore.PubSubConfig
object
6 properties
models.AmqpPubSubconfig
object
8 properties
util.ServerResponse
object
2 properties
models.PubSubConfig
object
6 properties
datastore.PubSubType
string
models.SourceResponse
object
19 properties
models.KafkaPubSubConfig
object
4 properties
datastore.KafkaAuth
object
5 properties
datastore.VerifierType
string
models.SQSPubSubConfig
object
4 properties
models.CustomResponse
object
2 properties
models.UpdateSource
object
10 properties
datastore.HMac
object
4 properties
datastore.VerifierConfig
object
4 properties
datastore.AmqpPubSubConfig
object
9 properties
models.HMac
object
4 properties 4 required
datastore.ProviderConfig
object
1 property
datastore.AmqpCredentials
object
2 properties
datastore.EncodingType
string
models.AmqpAuth
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convoy-sources-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 Subscriptions API
Where this information came from

This is an independent, third-party profile of Convoy Sources 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.