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

Event related APIs

Convoy Events 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 Event. 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 7 paths, and defines 42 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 7 paths 42 schemas 2 GET5 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 Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (ApiKeyAuth).

Paths & Operations 8

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

Events 8

Event related APIs

GET
/v1/projects/{projectID}/events
List All Events
GetEventsPaged 12 params → 200400401404
POST
/v1/projects/{projectID}/events
Create an Event
CreateEndpointEvent 1 param body → 201400401404
POST
/v1/projects/{projectID}/events/batchreplay
Batch Replay Events
BatchReplayEvents 12 params → 200400401404
POST
/v1/projects/{projectID}/events/broadcast
Create a Broadcast Event
CreateBroadcastEvent 1 param body → 201400401404
POST
/v1/projects/{projectID}/events/dynamic
Dynamic Events
CreateDynamicEvent 1 param body → 201400401404
POST
/v1/projects/{projectID}/events/fanout
Fan Out an Event
CreateEndpointFanoutEvent 1 param body → 201400401404
GET
/v1/projects/{projectID}/events/{eventID}
Retrieve an Event
GetEndpointEvent 2 params → 200400401404
PUT
/v1/projects/{projectID}/events/{eventID}/replay
Replay Event
ReplayEndpointEvent 2 params → 200400401404

Schemas 42

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

datastore.KafkaPubSubConfig
object
4 properties
models.BroadcastEvent
object
5 properties
datastore.SourceProvider
string
datastore.Source
object
19 properties
datastore.EndpointAuthenticationType
string
models.PagedResponse
object
2 properties
datastore.CustomResponse
object
2 properties
datastore.PaginationData
object
5 properties
datastore.BasicAuth
object
2 properties
datastore.GooglePubSubConfig
object
3 properties
datastore.EndpointAuthentication
object
4 properties
models.EventResponse
object
20 properties
httpheader.HTTPHeader
object
models.CreateEvent
object
6 properties
datastore.EventStatus
string
datastore.SourceType
string
models.DynamicEvent
object
7 properties
handlers.Stub
object
datastore.EndpointStatus
string
datastore.ApiKey
object
2 properties
datastore.SQSPubSubConfig
object
5 properties
datastore.TwitterProviderConfig
object
1 property
datastore.PubSubConfig
object
6 properties
models.FanoutEvent
object
5 properties
util.ServerResponse
object
2 properties
datastore.OAuth2
object
13 properties
datastore.PubSubType
string
datastore.OAuth2SigningKey
object
13 properties
datastore.KafkaAuth
object
5 properties
datastore.VerifierType
string
datastore.MtlsClientCert
object
2 properties
datastore.OAuth2ExpiryTimeUnit
string
datastore.HMac
object
4 properties
datastore.VerifierConfig
object
4 properties
datastore.AmqpPubSubConfig
object
9 properties
datastore.OAuth2FieldMapping
object
3 properties
datastore.Endpoint
object
22 properties
datastore.OAuth2AuthenticationType
string
datastore.ProviderConfig
object
1 property
datastore.AmqpCredentials
object
2 properties
datastore.Secret
object
6 properties
datastore.EncodingType
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convoy-events-api-openapi.yml Raw ↑

Other APIs Convoy publishes across the network.

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

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