|
| 1 | +--- |
| 2 | +title: "Filtering deliveries" |
| 3 | +description: "Gate which verified webhook deliveries run, with a type-safe filter checked against the event." |
| 4 | +sidebarTitle: "Filters" |
| 5 | +--- |
| 6 | + |
| 7 | +By default every verified delivery runs your `onEvent`. A **filter** is a server-side predicate that decides whether a delivery is routed at all. A delivery that does not match is still received and recorded, it just does not run anything. |
| 8 | + |
| 9 | +Filtering happens at the endpoint, before any run is triggered, so a filtered-out event costs you nothing. |
| 10 | + |
| 11 | +## Adding a filter |
| 12 | + |
| 13 | +Pass a `filter` string to `webhook()`. It is a small expression checked, at build time, against the event shape from your [source](/webhooks/sources#typing-the-event): |
| 14 | + |
| 15 | +```ts |
| 16 | +import { webhook, webhooks } from "@trigger.dev/sdk"; |
| 17 | + |
| 18 | +export const onOrder = webhook({ |
| 19 | + id: "orders", |
| 20 | + source: webhooks.stripe(), |
| 21 | + // only route succeeded payment intents over $100 |
| 22 | + filter: "event.type == 'payment_intent.succeeded' && event.data.object.amount >= 10000", |
| 23 | + onEvent: async ({ event }) => { |
| 24 | + // only runs for deliveries that matched |
| 25 | + }, |
| 26 | +}); |
| 27 | +``` |
| 28 | + |
| 29 | +The filter is type-safe: referencing a field that does not exist, or comparing it to the wrong kind of literal, is a compile error, not a runtime surprise. |
| 30 | + |
| 31 | +## What a non-match does |
| 32 | + |
| 33 | +A delivery that does not match is **not dropped**. It still returns `200` to the provider and is recorded as a [delivery](/webhooks/deliveries) with the status `FILTERED` and a reason naming the clause that failed (and the value it saw). It just never triggers a run. This keeps a filtered delivery auditable: you can see in the dashboard that it arrived and why it was not routed. |
| 34 | + |
| 35 | +<Note> |
| 36 | + If a filter throws while evaluating (for example, a malformed event), the delivery is routed rather |
| 37 | + than dropped. Filters fail open so a filter bug never silently swallows real events. |
| 38 | +</Note> |
| 39 | + |
| 40 | +## The expression language |
| 41 | + |
| 42 | +A filter is one or more `path operator value` clauses combined with `&&` and `||` (use parentheses to group). |
| 43 | + |
| 44 | +### Paths |
| 45 | + |
| 46 | +A path reads from one of three namespaces: |
| 47 | + |
| 48 | +- `event.*`: the verified, parsed request body, for example `event.data.object.amount`. |
| 49 | +- `header.*`: an inbound request header, matched case-insensitively, for example `header.x-github-event`. |
| 50 | +- `webhook.*`: endpoint metadata (`webhook.source`, `webhook.id`, `webhook.deliveryId`, and for per-tenant endpoints `webhook.externalRef` / `webhook.tenantId`). |
| 51 | + |
| 52 | +### Operators |
| 53 | + |
| 54 | +| Operator | Meaning | |
| 55 | +| --- | --- | |
| 56 | +| `==` `!=` | equality | |
| 57 | +| `>` `<` `>=` `<=` | numeric comparison | |
| 58 | +| `in` `not in` | membership in a list, for example `event.type in ['a','b']` | |
| 59 | +| `startsWith` `endsWith` `contains` | string matching | |
| 60 | + |
| 61 | +Values are strings in single quotes (`'created'`), numbers (`10000`), booleans (`true`), or a list for `in` / `not in`. |
| 62 | + |
| 63 | +### Comparing two fields |
| 64 | + |
| 65 | +The right-hand side can be another path instead of a literal, so you can compare two fields of the same event: |
| 66 | + |
| 67 | +```ts |
| 68 | +filter: "event.billing.country == event.shipping.country"; |
| 69 | +``` |
| 70 | + |
| 71 | +### Matching inside a list |
| 72 | + |
| 73 | +`any` and `all` quantify over an array, testing a sub-path on each element: |
| 74 | + |
| 75 | +```ts |
| 76 | +// route only if at least one line item has a positive quantity |
| 77 | +filter: "event.items any ( quantity > 0 )"; |
| 78 | +``` |
| 79 | + |
| 80 | +### Spacing |
| 81 | + |
| 82 | +The type checker reads the filter as a token stream, so a couple of spots are strict about spacing: keep `in` / `not in` lists unspaced (`['a','b']`, not `[ 'a', 'b' ]`) and put spaces around the quantifier parentheses (`any ( ... )`). |
| 83 | + |
| 84 | +To match only certain event types, write a clause against the field that carries the type: `event.type` for Stripe / Svix / Square / Discord, or the `x-github-event` header for GitHub (the filter DSL can read a `header.` namespace too): |
| 85 | + |
| 86 | +```ts |
| 87 | +import { webhook, webhooks } from "@trigger.dev/sdk"; |
| 88 | + |
| 89 | +export const onGithub = webhook({ |
| 90 | + id: "github", |
| 91 | + source: webhooks.github(), |
| 92 | + filter: "header.x-github-event in ['issues','pull_request']", |
| 93 | + onEvent: async ({ event }) => {}, |
| 94 | +}); |
| 95 | +``` |
0 commit comments