Here are some of the variables you can use when customising your Boomerang custom embeds. We strive for customisation when configuring your custom embeds. These variables will allow you to configure your embeds exactly to your preference. These variables can be used on any part of the embed.
These variables are case-sensitive. If a letter is a capital you must input a capital and vice versa. The guild, user, and time variables can be used in any module.
Global VariablesCopy link to section
These variables are available in all plugins and custom embeds.
Guild VariablesCopy link to section
| Variable | Description |
|---|---|
{guild.id} | Displays the ID of the guild the command was run in. |
{guild.icon} | Only can be used in the footer image, author image, thumbnail, or image. Displays the guild's avatar. |
{guild.name} | Displays the name of the guild the command was run in. |
{guild.vanity} | Displays the guild vanity invite. |
{guild.boosters} | Displays the amount of boosters the server has. |
{guild.members} | Displays the amount of members the server has. |
User VariablesCopy link to section
| Variable | Description |
|---|---|
{user} | Displays the username of the user who was specified. |
{user.name} | Displays the username of the user who was specified (same as ). |
{user.id} | Displays the ID of the user who was specified. |
{user.mention} | Mentions the user who was specified. |
{user.avatar} | Displays the user's avatar URL. Can be used in footer image, author image, thumbnail, or image fields. |
{user.display} | Displays the display name of the user who was specified. |
Time VariablesCopy link to section
| Variable | Description |
|---|---|
{timestamp} | Displays a relative timestamp (e.g., "2 hours ago"). |
{timestamp.full} | Displays a full timestamp (e.g., "January 1, 2024 at 12:00 PM"). |
Plugin-Specific VariablesCopy link to section
These variables are only available in their respective plugins.
Infractions PluginCopy link to section
| Variable | Description |
|---|---|
{case} | Displays the case number of an infraction. |
{type} | Displays the infraction type (e.g., "Warning", "Kick"). |
{reason} | Displays the reason for the infraction. |
{issuer} | Displays the username of the staff member who issued the infraction. |
{issuer.name} | Displays the username of the staff member who issued the infraction (same as {issuer}). |
{issuer.id} | Displays the ID of the staff member who issued the infraction. |
{issuer.mention} | Mentions the staff member who issued the infraction. |
{issuer.avatar} | Displays the issuer's avatar URL. Can be used in footer image, author image, thumbnail, or image fields. |
{issuer.display} | Displays the display name of the staff member who issued the infraction. |
{expiration} | Displays the expiration timestamp (formatted as full and relative timestamps, or "None provided" if no expiration is set). |
{status} | Displays the status of the infraction (e.g., "Expired"). |
{notes} | Displays the notes given for the infraction. Defaults to "No additional notes" if empty. |
Sessions PluginCopy link to section
| Variable | Description |
|---|---|
{server.code} | Displays the server code configured in the sessions settings. |
{players} | Displays the current player count in the ER:LC server if the API key is configured. Updates every 15 minutes. |
{queue} | Displays the current queue count in the ER:LC server if the API key is configured. Updates every 15 minutes. |
{staff} | Displays the staff count in the ER:LC server if the API key is configured. Updates every 15 minutes. |
{last.updated} | Displays a relative timestamp when the server data was last updated (e.g., "5 minutes ago"). |
{votes.required} | Displays the amount of votes required to start the session (for session vote embeds). |
Giveaways PluginCopy link to section
| Variable | Description |
|---|---|
{prize} | Displays the giveaway prize/title. |
{description} | Displays the giveaway description. |
{ends} | Displays the end time (relative and full timestamp). |
{host} | Displays the host mention (@username). |
{entries} | Displays the number of entries in the giveaway. |
{winners} | Displays winner mentions or the count of winners. |
Promotions PluginCopy link to section
| Variable | Description |
|---|---|
{rank.new} | Displays the new role name (the role being promoted to). |
{rank.previous} | Displays the previous role names (comma-separated list of previous roles). |
{reason} | Displays the promotion reason. |
{issuer} | Displays the manager/issuer username (who issued the promotion). |
{issuer.name} | Displays the username of the manager/issuer who issued the promotion
(same as |
{issuer.id} | Displays the ID of the manager/issuer who issued the promotion. |
{issuer.mention} | Mentions the manager/issuer who issued the promotion. |
{issuer.avatar} | Displays the issuer's avatar URL. Can be used in footer image, author image, thumbnail, or image fields. |
{issuer.display} | Displays the display name of the manager/issuer who issued the promotion. |
Bulk Promotions OnlyCopy link to section
These variables are only available when using bulk promotions.
| Variable | Description |
|---|---|
{users} | Displays all promoted users as mentions (one per line). |
{rank.previous} | Displays previous ranks (one per line, matches users). |
{rank.new} | Displays new ranks (one per line, matches users). |
Tickets PluginCopy link to section
| Variable | Description |
|---|---|
{subject} | Displays the ticket subject name. |
{ticketid} | Displays the ticket ID. |
{question.1} | Displays the answer to the first question from the ticket form/modal. |
{question.2} | Displays the answer to the second question from the ticket form/modal. |
{question.3} | Displays the answer to the third question from the ticket form/modal. |
{question.4} | Displays the answer to the fourth question from the ticket form/modal. |
{question.5} | Displays the answer to the fifth question from the ticket form/modal. |
Forms PluginCopy link to section
| Variable | Description |
|---|---|
{form.title} | Displays the title of the form. |
{form.status} | Displays the status of the form response (e.g., Approved, Denied). |
{form.response_url} | Displays the URL to view the form response on the web dashboard. |
{form.reason} or {reason} | Displays the decision reason provided when approving or denying the application. |
{question.<id>} | Displays the answer to a specific question on the form where <id> is the ID of the field. You can click the "Copy Variable" button (the overlapping squares icon) on any question in the form editor to automatically copy its exact variable to your clipboard. |
Bulk Messaging OnlyCopy link to section
These variables are only available when using the "Group Staged Results (Bulk Message)" feature.
| Variable | Description |
|---|---|
| Displays a space-separated list of mentions for all approved applicants. |
| Displays the total number of applicants being approved in this batch. |
{issuer} | Displays the username of the staff member who published the responses. |
{issuer.mention} | Mentions the staff member who published the responses. |
Logging PluginCopy link to section
| Variable | Description |
|---|---|
{host.name} | Displays the host's username. |
{host.id} | Displays the host's ID. |
{host.mention} | Mentions the host. |
{cohost.name} | Displays the co-host's username (Session Logs only). |
{cohost.id} | Displays the co-host's ID (Session Logs only). |
{cohost.mention} | Mentions the co-host (Session Logs only). |
{duration} | Displays the activity duration. |
{reason} | Displays the log reason (STS and Priority Logs only). |
{result} | Displays the activity result (Ridealong Logs only). |
{notes} | Displays additional notes (Ridealong Logs only). |
Request PluginCopy link to section
| Variable | Description |
|---|---|
{reason} | Displays the reason provided for the request. Defaults to "No reason provided" if none is given. |
Plus global variables (user, guild, and time variables) are also available.
Anti-Ping PluginCopy link to section
Uses only global variables (user, guild, and time variables).
Suggestions PluginCopy link to section
| Variable | Description |
|---|---|
{suggestion} | The content of the suggestion being posted. |
{user.name} | The name of the user who submitted the suggestion (or "Anonymous" if anonymous). |
Feedback PluginCopy link to section
| Variable | Description |
|---|---|
{rating} | The numerical rating out of 5. |
{stars} | The star representation (e.g. ⭐⭐⭐). |
{feedback} | The text of the feedback submitted. |
{staff.name} | The username of the staff member being rated. |
{staff.id} | The Discord ID of the staff member being rated. |
{staff.mention} | A mention of the staff member being rated. |
{staff.avatar} | The avatar URL of the staff member being rated. |
{staff.display} | The display name of the staff member being rated. |
ERLC Event LogsCopy link to section
| Variable | Description |
|---|---|
{player.name} | The username of the player (Join/Leave logs). |
{player.id} | The ID of the player (Join/Leave logs). |
{player.mention} | A mention of the player (Join/Leave logs). |
{killer.name} | The username of the killer (Kill logs). |
{killer.id} | The ID of the killer (Kill logs). |
{victim.name} | The username of the victim (Kill logs). |
{victim.id} | The ID of the victim (Kill logs). |
{caller.name} | The username of the caller (Mod Call logs). |
{caller.id} | The ID of the caller (Mod Call logs). |
{responder.name} | The username of the responding moderator (Mod Call logs). |
{responder.id} | The ID of the responding moderator (Mod Call logs). |