Placeholders

List of Kiai placeholders for messages and notifications.

Placeholders

Kiai provides a set of placeholders that you can use in several places, such as:

  • Level-up messages
  • XP Streak messages
  • XP Drop messages
  • Custom Message rewards
  • Nickname rewards and the Nickname Format setting

Not every placeholder works in every location, since some locations do not have the data a placeholder needs. If you use an unsupported placeholder, it appears as plain text in the message instead of being replaced.


Where Each Placeholder Works

LocationSupported placeholders
Level-up message{guild.*}, {user.*}, {level}, {level.new}, {level.old}, {prestige}, {rewards.*}
XP Streak message{guild.*}, {user.*}, {streak}, {bonus}
XP Drop message{guild.*}, {xp}, {expire}
Custom Message reward{guild.*}, {user.*}, {level}, {level.new}, {level.old}
Nickname reward / Nickname Format{guild.*}, {user.*}, {level}, {level.new}, {level.old}

{streak} and {bonus} only work in XP Streak messages. {expire} only works in XP Drop messages. Webhook rewards do not support placeholders.


List of Placeholders

Placeholder NameExampleNotes
{guild.id}744282929684938844
{guild.name}Buape Studios
{guild.icon}https://cdn.discordapp.com/icons/744282929684938844/b0fb371b25e6689eff94692c63c0f7a5.pngFalls back to a generic Discord icon if the server has none
{guild.owner}<@439223656200273932>Rendered as a mention on Discord
{guild.owner.id}439223656200273932
{user}<@439223656200273932>Rendered as a mention on Discord
{user.mention}<@439223656200273932>Same as {user}
{user.id}439223656200273932
{user.username}4shadowedThe member's Discord username
{user.globalName}ShadowThe member's Discord display name. Falls back to their username if they have not set one
{user.discriminator}0Discriminators are deprecated on Discord and included here for legacy servers
{user.color}#ff8d00The member's Discord profile accent color, in lowercase hex. Resolves to # alone if the member has not set one
{user.avatar}https://cdn.discordapp.com/avatars/439223656200273932/b0fb371b25e6689eff94692c63c0f7a5.pngFalls back to a generic Discord avatar if the member has none
{xp}100Only resolves where XP data is available, such as XP Drop messages
{level}10Same as {level.new}
{level.old}9The member's level before this change
{level.new}10The member's level after this change
{prestige}2The member's current prestige. Level-up messages only
{streak}7The member's current streak, in days. XP Streak messages only
{bonus}15The bonus XP earned for the streak. XP Streak messages only
{expire}in 5 minutesA relative time showing when a drop expires. XP Drop messages only
{rewards.roles.added}<@&439223656200273932>Rendered as a mention on Discord
{rewards.roles.removed}<@&439223656200273932>Rendered as a mention on Discord
{rewards.roles.added.ids}439223656200273932,744282929684938844Reward IDs, not role IDs
{rewards.roles.removed.ids}439223656200273932,744282929684938844Reward IDs, not role IDs
{rewards.money}100Total money awarded across bank and cash rewards
{rewards.money.total}100Same as {rewards.money}
{rewards.money.bank}100Amounts of bank-only money rewards, listed separately, not summed
{rewards.money.cash}100Amounts of cash-only money rewards, listed separately, not summed