[POST] /filters/test

Test and validate your filters configuration by using the /filters/test REST API before creating a webhook subscription to ensure that your filter is configured correctly.

NameTypeDescription

Authorization

String

The AIrstack API key.

Body

NameTypeDescription

eventTypes

Type of events for the webhooks to subscribe to. Check out EventTypes for all the available event types.

filter

Filter configuration to only listen to certain events that fulfill the inputted filter. Depending on the event types that you are subscribing to, the API will accept a different filter schema. For more advanced filter patterns, check Convoy's docs on filter here.

payload

Sample input for verification with the API.

Success Response (Status 200)

NameTypeDescription

status

Boolean

true

Fail Response (Status 400)

NameTypeDescription

status

Boolean

false

Last updated