ScarletHooks allows each clan on your server to have its own dedicated webhook for receiving clan chat and login/logout notifications. This enables private communication channels for each clan, such as separate Discord channels.

How Clan Webhooks Work

• Each clan can have a unique webhook URL.
• Clan webhooks receive messages for clan chat and (optionally) clan member login/logout events.
• Clan webhooks are managed separately from admin and public webhooks.

Setting Up a Clan Webhook

1. Add the Clan In-Game

Use one of the following commands as an admin to register a clan for webhooks:

.hooks add <clan-name>

or

.hooks afp <player-name>

(The second command will detect the clan from the specified player's data.)

This will create an entry for the clan in the ClanWebHookUrls.json file.

2. Edit the Clan Webhook URL

Open the file:

BepInEx/config/ScarletHooks/ClanWebHookUrls.json

Find the entry for your clan and set the desired webhook URL.
Example:

{
  "NightStalkers": "https://discord.com/api/webhooks/your-clan-webhook-url",
  "BloodHunters": "https://discord.com/api/webhooks/another-clan-webhook-url"
}

3. Reload Webhooks

After editing the JSON file, reload the webhooks in-game or restart your server:

.hooks reload webhooks

Enabling Clan Webhook Routing

In your ScarletHooks.cfg, make sure to enable clan message routing:

[Clans]
ClanLoginMessages = true

You can also control whether clan chat and login/logout messages are sent to admin or public webhooks via the [Admin] and [Public] sections.

Notes

• If a clan webhook URL is missing or set to null, messages for that clan will not be sent.
• You must always create the clan entry via command before editing the JSON file.
• Removing a clan via command will remove its entry from the JSON file.
• Clan webhooks are ideal for private Discord channels or other group chat integrations.

For more details on routing and configuration, see Webhook Routing & Examples and Configuration Guide.