PUT
/
v1
/
projects
/
{projectID}
/
subscriptions
/
{subscriptionID}
/
filters
/
{filterID}
curl --request PUT \
  --url https://dashboard.getconvoy.io/api/v1/projects/{projectID}/subscriptions/{subscriptionID}/filters/{filterID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "body": {},
  "event_type": "<string>",
  "headers": {},
  "is_flattened": true
}'
{
  "message": "<string>",
  "status": true,
  "data": {
    "body": {},
    "event_type": "<string>",
    "headers": {},
    "raw_body": {},
    "raw_headers": {},
    "subscription_id": "<string>",
    "uid": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Path Parameters

projectID
string
required

Project ID

subscriptionID
string
required

Subscription ID

filterID
string
required

Filter ID

Body

application/json
Updated filter
body
object

Body matching criteria (optional)

event_type
string

Type of event this filter applies to (optional)

headers
object

Header matching criteria (optional)

is_flattened
boolean

Whether the filter uses flattened JSON paths (optional)

Response

200
application/json
OK
message
string
status
boolean
data
object