Skip to main content
POST
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
/
filters
/
test
/
{eventType}
Test a filter
curl --request POST \
  --url https://us.getconvoy.cloud/api/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/test/{eventType} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "payload": "<unknown>"
}
'
{
  "message": "<string>",
  "status": true,
  "data": {
    "is_match": true
  }
}

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

​
eventType
string
required

Event Type

Body

application/json

Payload to test

​
payload
any
required

Sample payload to test against the filter (required)

Response

OK

​
message
string
​
status
boolean
​
data
object