Moderation - Variables
Moderation sends its messages from templates you can change: the DMs members receive and the private confirmations moderators see. Open one with Customize template under DM Templates on the Settings tab, Customize Template under Infraction DM Template on the Infractions tab, or from the Templates page, which lists every template.
Which template is used when:
- Ban DM:
/ban,/forcebanand/softban.{appeal_url}holds the appeal form link only for/banand/forceban, and only while the Forms module and its appeal form are enabled; otherwise it is empty, so write the template to read well either way. - Kick DM, Timeout DM, Warning DM:
/kick,/timeout,/warn, and the same actions taken by thresholds, Automations or in Discord. - Infraction DM: when an infraction threshold fires, after the action's own DM.
- Ban, Kick, Timeout and Warning Confirmation: the private reply the moderator sees.
- Appeal Denial DM: when staff deny a ban appeal, from the review buttons or the dashboard (see Ban Appeals). A permanent denial gets the Forms module's default message instead.
/mute, /note, the "un" commands and the mass commands send no DM. When Include reason in DM is off, {reason} in a DM reads "Not shared".
In a message template, write a variable in braces, for example {reason} or {server.name}, and add filters with a pipe, for example {reason | upper}.
| Template | Slug | Variable groups |
|---|---|---|
| Appeal Denial DM | @appeals.denial.dm | Author, Server, Appeal |
| Ban Confirmation | @mod.ban.confirm | Author, Server, Moderator, Action |
| Ban DM | @mod.ban.dm | Author, Server, Moderator, Action (Ban DM) |
| Infraction DM | @mod.infraction.dm | Author, Server, Action (Infraction DM) |
| Kick Confirmation | @mod.kick.confirm | Author, Server, Moderator, Action |
| Kick DM | @mod.kick.dm | Author, Server, Moderator, Action |
| Timeout Confirmation | @mod.timeout.confirm | Author, Server, Moderator, Action |
| Timeout DM | @mod.timeout.dm | Author, Server, Moderator, Action |
| Warning Confirmation | @mod.warn.confirm | Author, Server, Moderator, Action |
| Warning DM | @mod.warn.dm | Author, Server, Moderator, Action |
Appeal
| Variable | Description |
|---|---|
{denial_reason} | Appeal denial reason |
{ban_reason} | Original ban reason |
{appeal_url} | URL to the ban appeal form (empty if not configured) |
Action
| Variable | Description |
|---|---|
{reason} | Action reason |
{action} | Action name (Ban, Kick, Timeout, Warn) |
{case_id} | Moderation case number |
{case_url} | Jump link to the case log entry (empty if no log channel configured) |
{duration} | Action duration (e.g. 1h30m) |
{expires} | Discord relative timestamp when action expires |
Action (Ban DM)
| Variable | Description |
|---|---|
{reason} | Action reason |
{action} | Action name (Ban, Kick, Timeout, Warn) |
{case_id} | Moderation case number |
{case_url} | Jump link to the case log entry (empty if no log channel configured) |
{duration} | Action duration (e.g. 1h30m) |
{expires} | Discord relative timestamp when action expires |
{appeal_url} | URL to the ban appeal form (empty if not configured) |
Action (Infraction DM)
| Variable | Description |
|---|---|
{reason} | Action reason |
{action} | Action name (Ban, Kick, Timeout, Warn) |
{case_id} | Moderation case number |
{case_url} | Jump link to the case log entry (empty if no log channel configured) |
{duration} | Action duration (e.g. 1h30m) |
{expires} | Discord relative timestamp when action expires |
{points} | Current infraction point total |
{threshold} | Threshold that was reached |
The shared groups (Author, Server, Moderator) are listed with the common template variables. Every template also takes the Utility variables.
The shared Author, Server and Moderator variables, and the filters, are listed in the Message Builder guide.