Discord Webhook Configuration

Webhook alerts are disabled by default. Configure the URL, violation threshold, cooldown, and allowed role mentions in webhook.yml.

What this file controls

Webhook delivery is disabled by default. Treat the URL as a secret: never include it in documentation, screenshots, issue reports, or public logs.

Role IDs are the supported mention mechanism; ordinary everyone, here, and user mentions are disabled. The configuration also controls connection/read timeouts and retry limits.

The sample defaults include enabled: false, minimum-vl: 2.0, and cooldown-ms: 2000. Adjust the threshold and cooldown to match your staff workflow.

Bring a webhook up without leaking the secret

  1. Back up the generated file and keep the webhook URL private.
  2. Set enabled to true only when Discord delivery is intended, then add the webhook URL.
  3. Review minimum-vl (sample default 2.0), cooldown-ms (2000), connect-timeout-ms and read-timeout-ms (5000), max-retries (3), and retry-base-delay-ms (1000).
  4. Review suppress-notifications and allowed-role-ids to control mentions, then test delivery with a controlled alert. Redact the URL when recording results.

Apply and verify changes

After editing a setting, use the reload command when that setting supports reload. If the change does not take effect, check the configuration troubleshooting guide for the setting’s restart requirements.

Browse all documentation