* fix(log): preserve structured error details Error objects lose their useful details when serialized as plain JSON. Keep the message, stack and cause in structured log output. * fix(runtime): bound shared in-flight waits A canceled request can leave its shared promise pending forever. Bound joins and coordinate a single replacement so later requests make progress without multiplying upstream work. * fix(bot): reject oversized callback bodies Reject declared oversized bot callbacks before reading their bodies. This keeps unauthenticated requests from wasting worker resources. * test(d1): exercise real sqlite transactions Exercise real foreign keys, transactions and conditional statements instead of mocks that cannot reproduce lost updates or cascades. * fix(storage): preserve claims across kv fallback Only missing tables justify KV fallback; other failures must surface. Remember fallback writes so migration to D1 cannot forget claims and replay completed work. Share marker checks without extra writes. * fix(filter): use isolated linear-time patterns Backtracking patterns can exhaust worker CPU on untrusted payloads. Use linear-time matching and separate bounded cache namespaces so glob and regex entries cannot corrupt each other. * fix(filter): read each event branch correctly Deployment and check branches live in event-specific nested fields. Read those fields and remove only the actual leading ref prefix. * fix(filter): read only own payload properties Inherited object properties are not webhook payload data. Read own properties only so JSONPath cannot traverse prototypes. * fix(filter): validate executable condition trees Malformed trees and unsupported patterns must not silently turn an exclude rule into a pass. Validate the shape and only the patterns the evaluator actually executes. * fix(i18n): bound and cache translation loads Repeated misses and simultaneous override loads spend KV reads for the same language. Cache confirmed misses and share bounded loads without caching read failures as missing translations. * i18n(bot): explain command and account failures Explain account linking, command failures and skipped delivery outcomes consistently in both supported languages. * fix(github): bound and reuse app token fetches Repeated token exchanges waste requests and JWT work for every event. Reuse valid installation tokens, share refreshes and back off briefly after failures while keeping every shared wait bounded. * fix(github): restrict enrichment request urls Webhook-provided URLs must never receive an installation token on another host. Restrict enrichment to GitHub repository API paths, reject redirects and bound optional requests. * fix(formatter): preserve invalid code points Out-of-range numeric entities can throw while formatting a delivery. Keep invalid code points verbatim instead of aborting the message. * fix(formatter): preserve bounded markdown text Code spans, fences, indentation and autolinks are Markdown content, not HTML tags to strip. Preserve them while bounding cleanup input and reusing results across routes for the same event. * fix(formatter): strip only leading ref prefixes A short branch or tag may itself contain refs/heads or refs/tags. Strip one leading full-ref prefix at the caller and keep short names unchanged when generating labels and links. * fix(gitea): link push authors to their forge A Gitea author is not the same-named GitHub account. Build author profile links from the originating forge. * fix(formatter): render deployment state values The deployment status object stringifies as [object Object]. Render its actual state in the status field. * fix(formatter): read security severity levels The scanner severity is not the security severity of an alert. Prefer the security level so critical and high alerts get the right label and color. * fix(formatter): hide actions on other forges Action buttons call the GitHub API as the linked user. Hide them for other forges to avoid operating on a same-named GitHub repository. * fix(check): isolate updates by check suite Same-named checks from different suites must not edit one message. Include the suite or app identity and retain the former key for controlled adoption of existing tracked messages. * fix(logs): scope queries before limiting results Filter authorized groups in SQL before LIMIT and aggregate only visible rows. Preserve current group attribution for late writes, surface read failures and combine related totals in one scan. * perf(d1): index pruning and failed send queries Pruning and failure views should not scan all historical rows. Index the high-value access paths without adding a write-heavy index for infrequent delivery-detail lookups. * fix(discord): bound individual api requests An unbounded API request can outlive an update-chain lock. Bound each request so another holder cannot race a late edit. * fix(discord): defer long rate-limit waits Long rate-limit sleeps block delivery progress inside a worker. Return a retryable 429 for the queue when the wait exceeds the bound. * fix(discord): encode channel path segments Stored channel and message ids are path segments, not URL paths. Encode them so aliases cannot address another Discord resource. * fix(discord): reuse nonces after lost responses A successful create may lose its response. Reuse a stable nonce with enforce_nonce so retries recover that message instead of posting duplicates or accepting an unreadable success. * fix(discord): constrain embeds and role mentions Respect combined embed and component limits as well as field caps. Restrict allowed mentions to validated route roles so payload text cannot notify everyone. * fix(discord): resume bounded command syncs Application changes, command rollbacks and large guild lists can leave commands stale indefinitely. Track the current hash per app and resume bounded paginated work without needless KV writes. * fix(github): verify installation management An installation id is user-controlled, and repository access is not installation management. Verify the owning account or an active organization admin using the user token and read:org scope. * fix(github): resolve immutable member ids A login can be renamed and reclaimed before its first sign-in. Resolve the current immutable user id when membership is granted so a future holder of the login cannot inherit access. * fix(auth): revoke stale sessions and tokens Revoked or rotated credentials must stop working despite stale KV replicas. Track the live token and revocations in D1 and preserve immutable identity bindings rather than trusting a recycled login. * fix(auth): bind sessions and tokens to identity Automatic retries can repeat non-idempotent user actions. Disable those retries and expose a write hook so bot handlers can record completion immediately before the GitHub write. * fix(discord): defer and deduplicate interactions Acknowledge slow actions before Discord times out and deduplicate interaction writes. Preserve comment text and reject edits whose source changed after the modal opened. * fix(telegram): always verify webhook secrets Webhook verification must not silently disable itself when the optional secret is absent. Derive a stable secret from the bot token and reject callbacks when verification is unavailable. * fix(telegram): bound individual api requests Bound individual platform calls so they cannot outlive the lock protecting a message update or stall a whole delivery invocation. * fix(telegram): honor nested rate-limit delays Telegram places retry_after inside parameters, not at the top level. Read that value and defer long waits to the delivery queue. * fix(telegram): report unreadable send results An unreadable successful response may already have sent the message. Report an explicit uncertain result instead of retrying a create without an idempotency key or pretending it succeeded. * fix(telegram): keep editable messages as text Guessing photo versus text from message content makes later edits use the wrong API and a smaller caption budget. Always send text and use the avatar as a link preview. * fix(telegram): render hard breaks as newlines Telegram HTML does not support br tags. Render Markdown hard breaks as plain newlines so otherwise valid messages are accepted. * fix(telegram): clamp visible html characters Telegram counts visible characters, not HTML source bytes. Truncate without splitting tags, entities or surrogate pairs. * fix(telegram): honor the author emoji toggle The author marker must obey the group emoji preference just like formatter-added decoration. * fix(telegram): keep completed commands claimed Redelivery after a completed write must never post another comment. Keep completion claims despite reply failures, scope updates per bot and only issue account-login links in private chats. * fix(feishu): bound individual api requests Bound individual platform calls so they cannot outlive the lock protecting a message update or stall a whole delivery invocation. * fix(feishu): classify retryable api failures Business error codes can be transient even in HTTP 200 responses. Classify token and rate-limit errors for retry and defer long waits. * fix(feishu): retry sends with stable uuids An unreadable response does not prove a send failed. Reuse the same uuid for retries so recovering the result cannot create a second Feishu message. * fix(feishu): refresh and evict tokens safely Separate app token caches, stop reusing refused tokens and share refreshes. Cache failures briefly and keep valid tokens in memory when a best-effort KV cache write fails. * fix(feishu): use the card update endpoint Delayed card updates use the card update endpoint; the config endpoint cannot update an interaction response. * fix(feishu): neutralize untrusted mentions Forge text is untrusted and can contain at-all tags. Neutralize mentions in card bodies and footers before rendering. * fix(feishu): authenticate and dedupe callbacks Authenticate signed or token-verified callbacks before dispatching commands. Decode encrypted envelopes and handle card actions using the correct fields without claiming irrelevant chat events. * fix(target): normalize actual destinations Different target spellings can name the same actual destination. Normalize channel, thread and topic identities for ownership checks and per-route duplicate suppression. * fix(config): transact per-group configuration Whole-table writes and cached snapshots can overwrite other groups or resurrect removed configuration. Use per-group guarded writes, one-time identity migration and explicit unreadable-row failures. * fix(group): preserve identity through lifecycle Group names are mutable and reusable, so they cannot own durable state. Preserve immutable identities across lifecycle operations and commit invite use with membership under transaction-time guards. * fix(oauth): confirm account links and installs A login link or installation id is not proof of account ownership. Verify installation management, bind browser state and require an explicit account-link confirmation before granting chat access. * fix(queue): fence leases and record target outcomes Retries must remember completed targets and distinguish active lease holders. Fence state updates, preserve permanent outcomes and reject missing parked payloads instead of dispatching empty data. * fix(dispatch): isolate and resume tenant sends Check tenant sources before filters and never dispatch orphan routes. Record each target outcome, isolate update chains by forge and group identity, and keep stale events from overwriting newer messages. * fix(queue): bound batches and resume deliveries A queue invocation has shared query and subrequest limits. Use a small batch and shared send budget, renew fenced leases and resume only unfinished work without exhausting unstarted messages. * fix(admin): guard revisions and tenant targets Read-time authorization alone cannot protect concurrent edits. Guard revisions, current roles and destination ownership in the write transaction, and use per-group endpoints for isolated changes. * fix(webhook): confirm only accepted deliveries Acknowledging before queue acceptance permanently loses deliveries. Confirm only accepted work, release failed claims, scope replay identities and strip tenant-supplied installation authority. * fix(storage): prune abandoned parked payloads Oversized payloads can remain after interrupted enqueue attempts. Prune objects beyond their retry lifetime without deleting payloads that a current delivery may still need. * fix(console): expose api conflict statuses Callers need the HTTP status to distinguish stale edits from other failures and reload current data after a conflict. * refactor(console): model group revisions Carry server revisions explicitly so console writes can reject changes based on an outdated group snapshot. * fix(console): send loaded route revisions Send the revision actually loaded with the route list and adopt the server response after a save. Reload on conflict instead of silently overwriting another editor. * fix(console): guard fragment saves by revision Fragments share a group version with other configuration writes. Submit the loaded revision and reload on conflict to preserve concurrent edits. * fix(console): save groups with guarded writes Whole-list saves can overwrite unrelated groups. Use per-group revision-aware writes, retain rename results and confirm deletion on the exact group, routes and version shown to the user. * fix(console): reject edits of stale routes A conflict reload can leave an older route editor open. Compare its original value before saving so it cannot overwrite the newly loaded route. * fix(console): show overview loading failures Failed overview requests must not look like an empty dashboard or a successful refresh. Show the reason while retaining prior data. * fix(console): explain rejected install bindings Explain why an installation binding was refused instead of silently returning to the console with no visible outcome. * fix(console): allow selecting a group named all The all sentinel collides with a valid group id. Use a value that cannot be a group id so that group stays selectable. * fix(console): discard stale log detail responses An older detail request can finish after a newer selection or close. Discard it so the dialog never shows the previously clicked record. * fix(console): retain legacy group owners Groups predating member roles store owners in adminIds. Load those as owners so adding a member never drops all old owners. * fix(console): lock member edits during saves Edits made during a save are overwritten by its result. Disable member controls and guard handlers until the write settles. * fix(console): show invite loading failures Failed invite loads must not look like no pending invites. Show the error and discard responses from a previously shown group. * fix(console): retain legacy discord log targets A stored log target without platform means Discord. Keep that meaning in the editor instead of clearing the target. * fix(console): retain undisplayed forge sources An editor that only displays some providers must preserve the others. Keep stored custom sources when saving unrelated group settings. * fix(console): lock the group editor while saving Prevent edits while a group save is in flight and make super-only installation settings readonly instead of silently ignoring edits. * fix(console): lock route edits and show failures Lock the route editor while saving and show fragment load failures with a retry action rather than presenting a false empty list. * fix(config): expose the legal contact override Declare the public runtime key so the documented environment override reaches legal pages in deployed Nuxt builds. * build(deploy): migrate d1 before deployment Apply pending D1 migrations before deploying code that requires them. Stop deployment when migration fails instead of running against an incomplete schema. * docs(worker): align guides with runtime behavior Synchronize both language guides, API references and examples with the implemented authorization, storage and delivery behavior. Document migration requirements and accepted operational limits. * fix(storage): repair orphaned KV routes Repair orphaned KV routes before serving KV-only configuration. * fix(security): fully escape forge HTML --------- Co-authored-by: RhenCloud <i@rhen.cloud>
15 KiB
Filter Tutorial
Filters decide which webhook events a route forwards. A route fires only when every filter in its filters array matches (AND logic). This page is a hands-on tutorial: it explains how each filter type behaves and how to combine them into real-world routing rules.
See Filter Types in the configuration guide for the reference table, and Supported Events for the full event list.
How Matching Works
- All filters in a route must match, otherwise the route is skipped.
- Each filter matches the event against one field of the webhook payload.
- Matching is case-insensitive for every filter type.
- The
matchvalue accepts either a single string or an array of strings. An array behaves as OR — the filter matches if any of its values match. - Setting
"exclude": trueinverts the result (NOT logic): the filter matches when the value does not match.
{
"type": "event",
"match": ["push", "pull_request"],
"exclude": false
}
The route above matches both push and pull_request events.
Pattern Syntax
Every filter type shares the same three pattern forms:
| Pattern | Meaning |
|---|---|
plain text |
Field filters: exact match. keyword: search anywhere. |
* / ? |
Glob wildcards — * any run, ? one char. |
/regular expression/ |
Compiled as a regular expression (case-insensitive flag). |
- On field filters (
event/repo/actor/action/branch), plain text and globs match the whole value; onkeywordthey search anywhere in the payload. - Regexes always search:
/^feat/matches values starting withfeat,/feat/matches anywhere.
Examples:
{ "type": "event", "match": "pull_*" }
Matches pull_request, pull_request_review, pull_request_review_comment, ...
{ "type": "repo", "match": "myorg/*" }
{ "type": "branch", "match": "feature-?" }
Matches feature-x, feature-1, but not feature-xy.
{ "type": "branch", "match": "/^feat/" }
Matches any branch whose name starts with feat.
Tip
Globs and regular expressions are case-insensitive too, and
*matches across/in repo names (myorg/*also matchesmyorg/sub/backend).
Filter Types in Depth
event — Event type
Matches the GitHub event name, e.g. push, pull_request, issues, release. Use this as the backbone of every route.
{ "type": "event", "match": "release" }
Match several events with an array:
{ "type": "event", "match": ["create", "delete"] }
repo — Repository
Matches the repository full name (owner/name). Case-insensitive.
{ "type": "repo", "match": "myorg/backend" }
Route multiple repositories to one channel:
{ "type": "repo", "match": ["myorg/backend", "myorg/frontend"] }
actor — Sender
Matches the sender's GitHub login that triggered the event (sender.login in the payload). Useful for ignoring bots.
{ "type": "actor", "match": "dependabot[bot]", "exclude": true }
The route above fires for every event except those triggered by Dependabot.
action — Event action
Matches the action field of the payload, e.g. opened, closed, published, completed. Not all events carry an action — see Filter Compatibility. Combine it with event to narrow down a specific lifecycle step:
{
"type": "event",
"match": "pull_request",
"exclude": false
},
{
"type": "action",
"match": ["opened", "reopened"]
}
This fires when a pull request is opened or reopened (and not on merge/close/edit).
branch — Branch
Matches the branch involved in the event. What counts as "the branch" depends on the event type:
| Event | Branch extracted |
|---|---|
push |
The branch that was pushed to |
pull_request (and review) |
The pull request's head (source) branch |
create / delete |
The created/deleted branch or tag |
workflow_run |
The head_branch the workflow ran on |
workflow_job |
The head_branch the job ran on |
check_run |
The head_branch of the run's check suite |
check_suite |
The head_branch of the check suite |
deployment / deployment_status |
The deployment ref (deployment.ref, strips a leading refs/heads/) |
code_scanning_alert |
The alert's ref, without a leading refs/heads/ (use main, not refs/heads/main) |
{
"type": "event",
"match": "push"
},
{
"type": "branch",
"match": "main"
}
Fires for pushes to main only. To watch several long-lived branches:
{ "type": "branch", "match": ["main", "develop"] }
Note
branchmatching is case-insensitive. Use globs (feature/*) or a//-wrapped regex (/^release-/) for prefix or wildcard-style matching.
keyword — Text in the payload
Matches against the full JSON payload, lowercased. It is the most flexible filter: plain text searches anywhere, */? globs search with wildcards, and //-wrapped patterns are compiled as regular expressions (with the i flag).
{ "type": "keyword", "match": "deploy" }
Fires when the payload contains deploy anywhere. Because the payload is lowercased, this matches Deploy, DEPLOY, etc.
{ "type": "keyword", "match": "*release-*" }
{ "type": "keyword", "match": "/^(fix|hotfix)/" }
{ "type": "keyword", "match": "/release-[0-9]+/" }
Behavior details:
- Patterns longer than 200 characters cannot be compiled as glob/regex; such patterns are rejected when saved.
- Globs and regular expressions run on the RE2 engine, whose matching time is linear in the input — no pattern can stall the worker. RE2 syntax has no backreferences (
\1) or lookaround ((?=…),(?<!…)); the console and API reject such patterns. - A
//-wrapped pattern that is not a valid regex is rejected when saved. - To search for text that is a glob or regex special character (e.g.
v1.2.3), rely on the plain-text form — a pattern without*,?, or//wrapping matches literally. - The search covers the entire payload: commit messages, PR titles and bodies, labels, refs, even repository and sender names.
Combining exclude with keyword
Just like the other filters, exclude inverts the keyword match:
{ "type": "keyword", "match": "/wip|draft/", "exclude": true }
Skips events whose payload mentions wip or draft.
field — Any payload field (JSONPath)
Matches an arbitrary field of the webhook payload using a dot-separated path, e.g. pull_request.user.login, repository.private, or check_run.conclusion. Array fields are expanded automatically — the filter matches if any element matches.
{ "type": "field", "path": "pull_request.user.login", "match": "dependabot[bot]" }
{ "type": "field", "path": "labels.name", "match": "bug" }
Operators
Field filters (and every filter type except keyword) accept an op to change how the value is compared. The default eq keeps the classic glob/regex/exact behaviour.
| Operator | Meaning |
|---|---|
eq (default) |
Equal — globs, regexes and plain text, case-insensitive |
ne |
Not equal (inverse of eq) |
contains |
Value contains the pattern (substring) |
startsWith |
Value starts with the pattern |
endsWith |
Value ends with the pattern |
regex |
Explicit regular expression match |
gt / gte |
Numeric greater-than / greater-or-equal |
lt / lte |
Numeric less-than / less-or-equal |
in |
Value equals any of the listed patterns |
exists |
The field is present (non-null); match may be omitted |
{ "type": "field", "path": "pull_request.commits", "op": "gt", "match": "1" }
{ "type": "field", "path": "label.name", "op": "startsWith", "match": "area/" }
Grouping (all / any / not)
A route can use a nested ast to combine filters with explicit grouping instead of a flat AND list. The ast node is one of { "all": [...] }, { "any": [...] }, or { "not": {...} }:
{
"id": "grouped",
"name": "Grouped",
"enabled": true,
"groupId": "eng",
"filters": [],
"ast": {
"all": [
{ "type": "event", "match": "pull_request" },
{
"any": [
{ "type": "field", "path": "pull_request.user.login", "match": "alice" },
{ "type": "field", "path": "pull_request.user.login", "match": "bob" }
]
}
]
},
"targets": [{ "platform": "discord", "channelId": "..." }]
}
When ast is present it takes precedence over filters; the route still carries a filters array (it may be empty). The admin console's route editor builds ast visually (all/any/not groups), shows a live explanation of the tree, and can test it against a pasted JSON payload via the Test match panel.
Values, field paths and the test event use searchable dropdowns. Suggestions come from GitHub's and Gitea's webhook definitions — events, the actions of the events the route filters on, common payload paths and their known values — each shown as its English key with a description in the console language; search matches the key first, then the English or Chinese description. Anything outside the list can still be typed and is validated before it is added; only values that can never match are rejected (an event name with spaces, a branch with characters git forbids, invalid regex syntax, a non-number for a comparison operator, …). Repository and actor values stay free-form because custom webhooks may carry any string. Text that is typed but not added with Enter blocks saving, fragment saving and test runs instead of being added or dropped silently. Several values can be typed or pasted at once, separated by commas or new lines; a /regex/ keeps its own commas, and with the matches regex (regex) operator only new lines separate values (a raw pattern such as ^v{1,3} may contain commas). Suggestions follow the operator: the substring operators compare text literally, so a glob suggestion becomes the text it implies (release/* → release/ for starts with, *[bot] → [bot] for ends with), matches regex offers each suggestion as the escaped, anchored pattern it means (^dependabot\[bot\]$, ^release/), and comparison operators get no suggestions. Switching between equals / not equals / in and matches regex rewrites /x/ ↔ x in the values already added — both forms compile to the same regular expression, so the condition keeps matching exactly the same. Other values stay as typed (literal, glob and substring comparisons differ from regular expressions on line breaks and Unicode case folding), and values that can never match under the new operator are flagged. Arrays are expanded along a field path, but a path that ends on an array (e.g. commits.modified) is compared as a whole — match one of its elements with contains; the editor switches to contains when such a suggested path is picked.
Named filter fragments
The route editor can save the current filter tree as a named fragment and insert it into other routes. Fragments are editor-side templates stored in D1 (d1_fragments); inserting a fragment inlines its node into the route's ast, so the matching engine itself never resolves fragment references.
Worked Example 1: PR alerts that skip bots and drafts
Forward pull request activity, but ignore bot authors and draft PRs, to a #prs channel:
{
"id": "pr-notices",
"name": "PR Notices",
"enabled": true,
"groupId": "eng",
"filters": [
{ "type": "event", "match": "pull_request" },
{ "type": "actor", "match": "dependabot[bot]", "exclude": true },
{ "type": "field", "path": "pull_request.draft", "match": "true", "exclude": true }
],
"targets": [{ "platform": "discord", "channelId": "111111111111111111" }]
}
The field filter reads pull_request.draft from the payload; combined with exclude: true it filters out draft PRs.
Worked Example 2: Release-only channel
Forward only published releases from a specific repo:
{
"id": "release-alerts",
"name": "Release Alerts",
"enabled": true,
"groupId": "eng",
"filters": [
{ "type": "event", "match": "release" },
{ "type": "action", "match": "published" },
{ "type": "repo", "match": "myorg/backend" }
],
"targets": [{ "platform": "discord", "channelId": "222222222222222222" }]
}
Worked Example 3: CI failures
Forward workflow runs that ended in failure on any branch, to a #ci channel:
{
"id": "ci-failures",
"name": "CI Failures",
"enabled": true,
"groupId": "eng",
"filters": [
{ "type": "event", "match": "workflow_run" },
{ "type": "action", "match": "completed" },
{ "type": "keyword", "match": "\"conclusion\":\"failure\"" }
],
"targets": [{ "platform": "discord", "channelId": "333333333333333333" }]
}
Common Pitfalls
- Wildcards are globs, not regex.
repo: "myorg/*"matches any repo undermyorg(andmyorg/sub/backend), butrepo: "myorg/.*"matches literally. Use//wrapping for regex:"/myorg\/.*/". - A
//-wrapped invalid regex is rejected. The console and API refuse it when saved; a route stored with one before is reported as unreadable and its group's deliveries retry until it is fixed. Unlike//-wrapped text, an unwrapped pattern is matched literally — wrap patterns only when they are real regular expressions. - An
actionfilter on an action-less event never matches. Check the event has anactionfield first (see Filter Compatibility). branchon an event without a branch never matches. Abranchfilter on anissuesevent will always be false. Usekeywordif you need branch-like matching there.keywordsearches everything. Because it scans the whole payload, a pattern like"fix"can match commit messages, issue titles, and repository names. Be as specific as possible.- Forgetting
excludesemantics.exclude: truenegates the whole filter — one non-matching value in an array does not "block" the route; the negated filter matches only when none of the values match.