Hookdeck
Filters overviewFilter syntaxCreate a filterEdit a filterDelete a filter

Filters overview

Filters allow you to permit and route webhooks conditionally based on the contents of their Headers, Body, Query, or Path.

The two most common uses of filters are:

  • Allowing only webhooks with useful information to pass through to a destination.
  • Routing webhooks to different destinations based on their contents, as in a fan out approach.

Filters utilize JSON, and support matching on any value (string, number, boolean, null), on nested objects, and on arrays. There is also support for special operators. For a full rundown of supported schema, see filter syntax.

Filter limitations

Filters were designed for JSON payloads. To filter XML payloads, please first transform the payload to JSON.

Basic, non-structured filters, such as partial or exact matches on strings, will function with XML payloads.

On this page

Filter limitations