Webhook Routing & Examples
Updated a month agoScarletHooks gives you fine-grained control over which types of messages are sent to each webhook (admin, public, login, and clan-specific). This page explains how routing works and provides practical configuration examples.
How Webhook Routing Works
-
Admin Webhook:
Receives messages intended for server admins. You can enable or disable which message types (global, local, clan, whisper, login/logout) are sent here via the[Admin]
section inScarletHooks.cfg
. -
Public Webhook:
Receives messages intended for the general community. You can enable or disable which message types are sent here via the[Public]
section inScarletHooks.cfg
. -
Login Webhook:
Optionally receives only login and logout messages, separate from chat notifications. Set the URL in the[General]
section. -
Clan Webhooks:
Each clan can have its own webhook for clan chat and login/logout notifications.
Important: To set up a clan webhook, you must first create the clan entry using an in-game command, then manually edit theClanWebHookUrls.json
file to add the webhook URL for that clan.
Example: Basic Routing
Send all message types to the admin webhook, but only global chat to the public webhook:
[Admin]
AdminGlobalMessages = true
AdminLocalMessages = true
AdminClanMessages = true
AdminWhisperMessages = true
AdminLoginMessages = true
[Public]
PublicGlobalMessages = true
PublicLocalMessages = false
PublicClanMessages = false
PublicWhisperMessages = false
PublicLoginMessages = false