Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
/
filters
Create a new filter
curl --request POST \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event_type": "<string>",
  "body": {},
  "headers": {}
}
'
{
  "message": "<string>",
  "status": true,
  "data": {
    "body": {},
    "event_type": "<string>",
    "headers": {},
    "raw_body": {},
    "raw_headers": {},
    "subscription_id": "<string>",
    "uid": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://getconvoy.io/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Path Parameters

​
projectID
string
required

Project ID

​
subscriptionID
string
required

Subscription ID

Body

application/json

Filter to create

​
event_type
string
required

Type of event this filter applies to (required)

​
body
object

Body matching criteria (optional)

​
headers
object

Header matching criteria (optional)

Response

Created

​
message
string
​
status
boolean
​
data
object