Synchronize both language guides, API references and examples with the implemented authorization, storage and delivery behavior. Document migration requirements and accepted operational limits.
1.6 KiB
Message Language (i18n)
Messages are rendered in the language configured per group. WebHooker ships with English (default) and Simplified Chinese dictionaries.
Per-Group Language
Set Group.lang (e.g. "zh") to choose the message language for every route in a group — see Groups → Group Schema. The group's webhook log-channel summaries use the same language.
Custom Overrides
Additional message languages are read from KV under the key i18n:<lang>: a JSON object with the same nested structure as the built-in dictionaries (server/lib/lib/locales/en.ts). Every key you do not provide falls back to English. The built-in en and zh are never read from KV, so they cannot be overridden this way; use another language code (e.g. zh-custom) and set it as the group's lang.
// KV key: i18n:zh-custom
{
"events": {
"push": { "title": "{repo}: 推送了 {count} 个提交到 {ref}" },
},
}
A loaded dictionary stays cached in each worker instance until it restarts, so a changed override may take a while to apply; a language with no override is looked up again after 5 minutes. Overrides affect group messages only — the console has its own built-in translations.
Emoji Toggle
Group.emoji (default true) controls whether event emoji appear in that group's messages. When disabled, the emoji the formatters add are left out of titles, descriptions, fields, and links; text taken from the payload (commit messages, issue titles, custom webhook fields) keeps any emoji it contains. Milestone progress bars (🟢🟡🟠⬜) are data visualization and stay regardless of the toggle.