Automations - Variables

Messages sent by Send a message, Reply to the message, Send the member a direct message and Post a log message use templates you save in the Message Builder. Set the member nickname and Create a thread take text with variables too. When a rule runs, these variables are filled in from the event that triggered it and from the rule itself:

Member

Server

Channel

Message

Reaction

Moderation

Levels and anti-raid

Changes

Invite

Role

Rule

Match

Spam

Every template also takes the Utility variables.

When each group is filled in:

• Member: the trigger has a member, a message author, or (for a moderation event on someone who already left) a user. {user.name} is their display name and {author.name} their username. For a reaction, the member is who reacted. {user.created_at} and {user.joined_at} are Discord timestamps, which every reader sees in their own time and language ("3 years ago").
• Server: always.
• Channel: the trigger has a channel or a message. {thread.parent} is filled when the event happened in a thread.
• Message: message and spam triggers, and reactions (the message reacted to). {message.author} is who wrote it, which for a reaction is usually someone other than {user}.
• Reaction: the reaction triggers. {reaction.emoji} shows the emoji as Discord does; {reaction.id} and {reaction.url} are only set for a server emoji.
• Moderation: the moderation triggers. {mod} and the other moderator variables are empty when nobody acted (a timeout that ran out). {timeout.end} is set on When a member's timeout ends.
• Levels and anti-raid: {level}, {level_before} and {xp_type} on the level-up triggers, {antiraid.level} on the anti-raid trigger ({mod} is then the staff member who changed it, and empty when the detector, decay or a rule did).
• Changes: what an update changed. A member change fills {roles.added}, {roles.removed}, {before.nick} and {after.nick}; a custom status {status} and {before.status}; a voice change {voice.action}, {before.channel} and {after.channel}; a role update the names, colours and permissions before and after; a thread update {before.name} and {after.name} (when the bot still had the thread's old version); the anti-raid trigger {before.level} and {after.level}; an edited message {before.content} (when the bot still had the message).
• Invite: When an invite is created.
• Role: When a role is updated: the role as it is now.
• Rule: always. {actions.summary} lists the rule's actions, whether or not each one succeeds.
• Match: {match.summary} says what the conditions matched (the words, patterns, links, invites and file types of the conditions that made the rule pass, and where they were found) or, on a spam trigger, the spam match, for example message spam: 6 events (threshold 5 in 10s). The other match variables describe the first condition that matched. They are empty when no content, link, invite, file or name condition matched.
• Spam: spam triggers. {spam.count} is how many messages are behind the match (for a join raid or thread spam: how many members joined or threads were created), {spam.archive_url} a link to the archive of those messages (a web page kept for 30 days; empty for join raids and thread spam, or without the Mod Logs module). On Any spam detected, which can match several detectors at once, {spam.amount} and {spam.window} are those of the first detector that matched.

Which trigger fills what

Variables that do not apply to an event are not filled in; for example a scheduled rule has no {user} or {channel}, so avoid them in scheduled messages. Some of these can still be empty on a trigger that fills them, as the notes above say: {voice.duration} for someone who joined voice before the bot started, {mod} when nobody acted. {match.summary} is written for Discord: formatting characters and mentions in the matched text are escaped. {match.value} and {match.text} are the plain text.

The Message Builder lists these variables for a template whose ID starts with automations.action, for example automations.action.invite-warning. Create template on an action gives the new template such an ID. Any template works with an action; the ID only decides what the variable list shows. Opened from a rule (Create template or Edit on one of its actions), the builder lists only the variables the rule's trigger fills, and so do the variable suggestions in an action's own text fields (a nickname, a thread name); Show all in the builder lists the rest, for a template several rules share.

In message templates, filters work as everywhere else, for example {message.content | truncate(100)} or {user.display_name | upper}. Nicknames and thread names take the plain variables only, without filters. See the Message Builder guide for the filters and the Utility variables every template has.