Discord Webhooks

Seven channels. Every one of them is optional, and all of them are off until you give them a URL.

#The channels

ServerConfig.Webhooks = {
    Default   = '',
    Proofs    = '',
    Deaths    = '',
    Admin     = '',
    Exports   = '',
    Errors    = '',
    Anomalies = '',
}

Set them from server.cfg instead, which is the better habit:

set recognition_webhook_default   "https://discord.com/api/webhooks/..."
set recognition_webhook_proofs    "https://discord.com/api/webhooks/..."
set recognition_webhook_deaths    "https://discord.com/api/webhooks/..."
set recognition_webhook_admin     "https://discord.com/api/webhooks/..."
set recognition_webhook_exports   "https://discord.com/api/webhooks/..."
set recognition_webhook_errors    "https://discord.com/api/webhooks/..."
set recognition_webhook_anomalies "https://discord.com/api/webhooks/..."

The convar always wins over the value in the file. An empty or unset convar leaves the file value alone.

#A channel that is off

A URL that does not start with https:// is treated as not configured. Discord logging is optional, so a channel you simply left empty gets no line of its own. At boot you see one line in total:

[5code-recognition] Discord log webhooks: none configured (optional).

or, when some channels have a URL, the list of the ones that post:

[5code-recognition] Discord log webhooks on: admin, proofs.

or, when default has a URL (every channel without a URL of its own then posts to it, the usual one-webhook setup):

[5code-recognition] Discord log webhooks on: all 7 channels.

A channel whose value was set but typed wrongly gets a warning of its own, naming the reason — it is an http:// URL, it does not start with https://, it is not a URL, the value is not text — so a typo never hides behind "I did not use that channel":

[5code-recognition] Webhook 'proofs' was ignored (it is an http:// URL), so it is off. Set an https:// URL in config_server.lua or its convar.

When default has a URL, the end of that line says so it posts to the default webhook instead. The lines are printed once per start, not again when settings are reloaded.

#What a message contains

ServerConfig.Discord = {
    Name = '5code-recognition',
    Avatar = '',
    IncludeServerIds = true,
    IncludeNames = true,
    IncludeCharKeys = true,
    IncludeLicenses = false,
    AttachFullData = true,
    MaxFileBytes = 1048576,
    ExportCooldownSeconds = 10,
    ExportsPerHour = 30,
    ThreadIds = {},
    SuppressNotifications = false,
}

#Presentation

Chart style and attachment format live in config.lua, because they are about how the export looks, not what it contains.

#The sending queue

Discord rate-limits webhooks hard. The queue keeps us inside their limits and backs off when we hit one anyway.

#The proof log check value

That message is an outside copy nobody on the server can edit, so you can compare the proof log with it later. Check the log in game or in the console with:

recognition:verifyproofs [fromId]

#Filtering proofs

A busy server produces a lot of on-duty police cuffs that nobody will read. Two keys thin them out without touching what is stored:

Everything is still written to recognition_proofs either way. See Proofs.

#Admin actions

#Photos

Photos have their own optional webhook, used only when ServerConfig.PhotoHost = 'discord':

ServerConfig.PhotoDiscord = {
    Webhook = '',   -- convar: recognition_photo_webhook
}

See Photos & Screenshots.

#Checklist

• URLs are in config_server.lua or in set convars — not config.lua, not setr.
• IncludeLicenses is false unless you have a written reason.
• The channels are private to staff.
• Errors and Anomalies point somewhere a human actually reads.
• The Proofs channel is filtered, or it will be unreadable by week two.