Skip to main content

Filters

The Filters page lets you create and manage named, reusable filter definitions at the project level. Named filters can be attached to multiple sources so you don't need to duplicate conditions across endpoints.

Creating a Filter

  1. Click Create Filter on the Filters page.
  2. Enter a name (up to 100 characters).
  3. Choose an action:
    • Allow — only events that match this filter's conditions are delivered.
    • Block — events that match this filter's conditions are dropped.
  4. Choose the logic mode:
    • AND — all conditions must match.
    • OR — any condition can match.
  5. Add one or more conditions (see below).
  6. Click Create.

Conditions

Each condition evaluates a field from the incoming event against a value.

Field Paths

Path formatExample
header.<name>header.X-GitHub-Event
body.<dot.path>body.action, body.pull_request.merged

Operators

OperatorMatches when…
eqfield equals value
neqfield does not equal value
containsfield contains substring
not_containsfield does not contain substring
includesfield equals one of a comma-separated list of values
existsfield is present and non-empty
not_existsfield is absent or empty
regexfield matches regular expression

See Filters for full operator and field path reference.

Test Panel

Use the Test panel to verify your filter logic before saving:

  1. Paste a sample JSON payload into the Payload field.
  2. Optionally add sample headers.
  3. Click Run Test.

The panel shows whether the event would be allowed or blocked by the current conditions. You can also seed the test panel automatically by creating a filter from an event — the event's payload and headers are pre-loaded.

Attaching Filters to Sources

Named filters are attached per source, not applied globally. To attach a filter:

  1. Open a source from the Sources page.
  2. Expand the Filters section and click Attach Filter.
  3. Select the named filter.

Each attachment has its own enable/disable toggle so you can pause a filter on one source without affecting others.

Editing and Deleting Filters

Click on a filter name to open the filter editor. You can update the name, logic, action, and conditions. Changes take effect immediately for all sources the filter is attached to.

To delete a filter, click the Delete button on the filter's detail page. Deleting a filter detaches it from all sources.

Creating a Filter from an Event

From an event detail page, click Create from event → New filter. The filter editor opens with the event's payload body and headers pre-loaded as the test example.