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

Filters related APIs

Convoy Filters 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 Filters. 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 9 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 9 schemas 1 DELETE2 GET3 POST2 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 Filters 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, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Filters 8

Filters related APIs

GET
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters
List All Filters
GetFilters 2 params → 200400401404
POST
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters
Create a New Filter
CreateFilter 2 params body → 201400401404
POST
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/bulk
Create Multiple Subscription Filters
BulkCreateFilters 2 params body → 201400401404
PUT
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/bulk_update
Update Multiple Subscription Filters
BulkUpdateFilters 2 params body → 200400401404
POST
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/test/{eventType}
Test a Filter
TestFilter 3 params body → 200400401404
DELETE
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}
Delete a Filter
DeleteFilter 3 params → 200400401404
GET
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}
Get a Filter
GetFilter 3 params → 200400401404
PUT
/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID}
Update a Filter
UpdateFilter 3 params body → 200400401404

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are models.FilterResponse (7 properties), models.UpdateFilterRequest (4 properties), models.BulkUpdateFilterRequest (4 properties), models.CreateFilterRequest (3 properties). Each schema is shown below with its type and property counts.

models.FilterResponse
object
7 properties
models.TestFilterResponse
object
1 property
datastore.M
object
models.CreateFilterRequest
object
3 properties 1 required
models.BulkUpdateFilterRequest
object
4 properties 1 required
util.ServerResponse
object
2 properties
models.UpdateFilterRequest
object
4 properties
handlers.Stub
object
models.TestFilterRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

convoy-filters-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 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 Filters 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.