Home / Reference / Message variables
Message variables
Use these tokens in chat messages, alert text, and TTS text. Availability depends on the trigger and actions that fired; the in-app Variables picker highlights what applies. Unset values leave the literal token in place. Names and meanings match the in-app variable registry.
In-app picker
The Variables button on template fields is the catalog (there is no token list under the box). It groups tokens that apply to the current editor:
- Active for this trigger - tokens supplied by the current automation/alert trigger or host (for example Counter Tier Reached, or dice
{roll}/{outcome}) - This screen - tokens registered for that template family (Saved List, Chat Game, Follow Age, and so on)
- Global (by name) - named counter and named community-goal lookups such as
{counter:Wins}or{goalCurrent:Subathon}
Other variables stays collapsed until you expand it or type in the search box. Unset values still leave the literal token in chat or overlay text.
Core
User, wheel, and Twitch event tokens. Chat/TTS and alert overlays share one {amount} cascade (counter precedence, then bits / viewers / resub months / gift count / hype / ad seconds). Prefer {bits} or {subs} when those apply. There is no separate {months} or {viewers} token. On YouTube Super Chat / Super Sticker, {amount} is the display string (for example $5.00); use {amountnumber} and {currency} for the parsed value. See YouTube.
| Variable | Value |
|---|---|
{user} | Viewer's display name (requires a Twitch trigger). On lookup-style commands this is the looked-up subject when an @user arg is present |
{caller} / {callerDisplayName} | Display name of the viewer who typed the command when {user} is a looked-up subject (Viewer Points balance, Follow Age, Watch Time, and Chat Command / Chat Bot when Allow checking another viewer is on). Equals {user} when there is no subject |
{randomViewer} | Random current chatter's display name (anyone in Twitch Helix chat or YouTube recently-chatted, including the linked bot). Same name for every use in one message, and for chat, TTS, Discord, and alerts on the same fire. A YouTube-only day is not empty. After !link, Twitch + YouTube is one ticket. Empty chat substitutes nothing. |
{displayName} | Alias for {user} (Follow Age / Watch Time) |
{winner} | Winning wheel entry text (also when an automation runs from a wheel entry win) |
{wheel} | Wheel / preset name |
{actionSet} | Name of the Action Set picked for this fire (uniform, no-repeat, or a counter pool). Chat, TTS, Discord, and the alert on that set share it, including after a countdown. A blank name substitutes nothing. The literal token stays when this fire did not pick a set, including cooldown replies and a nested Run Automation. |
{amount} | Shared numeric event value: Counter Value Changed abs-delta, wired Counter Action amount, community-goal delta, bits, raid/shoutout viewers, resub months, gift count, hype level, ad seconds, points given/wagered, point-drop claim amount, or chat game stake |
{message} | Alert overlay text typed by the viewer (same source as {input}). On Bits / Cheer, cheerN tokens are stripped so TTS does not repeat each emote |
{reward} | Channel point reward title |
{input} | User message or leftover text after a command / alias. On Bits / Cheer, same cheer-token strip as {message} |
{bits} | Bits spent (Bits / Cheer or Power-Up trigger) |
{subs} | Sub or gift count (Sub / Resub / Gift Sub) |
{tier} | Sub tier: 1, 2, or 3 |
{gifter} | Gifter display name (Subscription Gift Receiver; {user} is the recipient) |
{clipUrl} | Public clip URL after a successful Create Clip action on this fire. Play Clip can use this token as its source. Unset (literal token) if clip failed or the channel was offline. |
{clipId} | Clip id after a successful Create Clip action on this fire. Play Clip can use this token as its source. |
{predictionId} | Prediction id after a successful Create Prediction action on this fire. Unset if create failed. |
{predictionTitle} | Prediction title after a successful Create Prediction action on this fire. Unset if create failed. |
{pollId} | Poll id after a successful Create Poll action on this fire. Unset if create failed or the draft was queued because a poll was already live. |
{pollTitle} | Poll title after a successful Create Poll action on this fire. Unset if create failed or the draft was queued because a poll was already live. |
Counters
| Variable | Value |
|---|---|
{count} | Counter value after the current change for the first Counter Action row (when a counter action is configured). Uses thousands separators when that counter has the option enabled |
{value} | Alias for {count} |
{oldValue} | Counter value before a Counter Value Changed trigger (same thousands-separator setting as {count}) |
{delta} | Signed amount the counter changed by (same thousands-separator setting as {count}) |
{counter:Name} | Value of a named counter (for example {counter:Wins}). Per-user counters resolve for the triggering viewer when the message has one; with no user (Chat Bot timers, Stream Went Live) they use the Stats Total, same as {counterTotal:Name}. After a Counter Action on the same fire, uses that fire's post-update value for every updated row; otherwise the live current value. Uses thousands separators when that counter has the option enabled |
{counterTier} | Tier for the wired (first) counter action, or the tier just gained on Counter Tier Reached |
{counterTier:Name} | Tier label for a named counter. After a Counter Action on the same fire, uses the tier for that fire's post-update value; otherwise a live lookup |
{top5Counter:Name} | Top 5 for a per-user counter: 1. Name value, 2. Name value, ... (thousands separators when that counter has the option enabled) |
{counterTotal:Name} | Aggregate total for a named counter - global value, or sum of every user on a per-user counter (same Total as Counter Stats; thousands separators when enabled) |
Viewer Points
| Variable | Value |
|---|---|
{balance} | Looked-up subject's current point balance on !points / !points @user (thousands separators when the backing counter has them on) |
{caller} | Who typed !points when the balance is for another viewer |
{currencyName} | Currency display name |
{price} | Cost of the redeemable shop item |
{itemName} | Redeemable item name |
{giver} | Points giver's display name |
{recipient} | Points recipient's display name |
{giverBalance} | Giver's balance after a transfer |
{recipientBalance} | Recipient's balance after a transfer |
{target} | Admin-give target display name |
{pool} | Total claim slots rolled for a point drop (not points) |
{claimsLeft} | Remaining unclaimed slots in the active drop (not points) |
{pointsLeft} | Remaining points = claims left x points per claim |
{pointsPool} | Total points in the drop = claim slots x points per claim |
{amount} | Points awarded per successful point-drop claim for the active spawn (frozen at spawn time; also available as legacy {points}) |
Community Goals
Bare goal tokens appear on Community Goal check replies, contribute success / not-enough replies, and when a Community Goal Reached automation or alert fires. Named lookups ({goalCurrent:Name}, and so on) are always offered in the picker like named counters.
| Variable | Value |
|---|---|
{goalName} | Community goal name |
{goalCurrent} | Current progress |
{goalLimit} | Target limit |
{goalProgress} | Progress as current/limit (for example 15/100) |
{goalCycles} | How many times the goal has completed |
{goalOverflow} | Overflow progress after a completion |
{goalCurrent:Name} | Current progress of a named goal |
{goalLimit:Name} | Target of a named goal |
{goalCycles:Name} | Completion count of a named goal |
{amount} | Contribute: Viewer Points spent (or requested, on not-enough) |
{balance} | Contribute: remaining balance after a successful spend, or current balance on not-enough |
{currencyName} | Contribute: bound Viewer Points currency display name |
{user} | Viewer who typed the check or contribute command |
Saved Lists
Used in Chat Bot Saved List Read/Add reply templates. See Chat Bot - Saved Lists.
| Variable | Value |
|---|---|
{entry} | Entry text |
{number} | Stable entry number |
{listName} | List display name |
{game} | Twitch category captured with the list entry (if enabled). Not this stream's live category |
{date} | Local date/time when captured (if enabled) |
{addedBy} | Chatter who added the entry (if enabled) |
{user} | Viewer who ran the command |
Add / Edit Command
Used in the Chat Bot !addcommand / !editcommand confirmation Response. {command} is the built-in they typed; {name} and {response} are the command they created or updated. Do not reuse Saved List {entry}. Defaults are Added {name}: {response} / Updated {name}: {response}.
| Variable | Value |
|---|---|
{command} | The built-in they ran (for example !addcom) |
{name} | Command they created or edited (for example !project) |
{response} | Reply text they set on that command |
{user} | Viewer who ran the built-in |
Enable / Disable Command
Used in the Chat Bot !enablecommand / !disablecommand confirmation Response. {command} is the built-in they typed; {name} is the command name they typed. {response} is not offered. A template that still contains it substitutes empty. Defaults are Enabled {name} / Disabled {name}.
| Variable | Value |
|---|---|
{command} | The built-in they ran (for example !enablecom) |
{name} | Command they named (for example !project) |
{user} | Viewer who ran the built-in |
Stream
These tokens read the Stream Manager go-live line, how long the current broadcast has been live, and the last title/category ISB loaded from Twitch (Stream Manager, go-live send, or Set Title/Category). Use them in automations, alerts, Viewer Points, and other templates. Related: Stream Manager.
| Variable | Value |
|---|---|
{golive} | Go live chat message from Stream Manager (stored even when Send to live chat is off). Tokens inside that line (for example {category}) fill in when this token is used |
{category} | This stream's current Twitch category |
{title} | This stream's current Twitch title |
{uptime} | How long this broadcast has been live, in words (for example 1 hour 25 minutes). Under an hour, leftover seconds stay (25 minutes 9 seconds). Offline is 0 seconds. Not watch time or cooldown time |
Spotify
These tokens read the song on the connected Spotify player, including while it is paused. Use them in automations, alerts, chat, and TTS. Not connected, nothing playing, or no fetch yet leaves the literal token. A Spotify Song Changed automation keeps the song that started, even if another song is playing by the time the message sends. {track} and {artist} are the song-request row only (see Timers and commands). Progress and duration are m:ss, or h:mm:ss at an hour or more.
| Variable | Value |
|---|---|
{spotifyTrack} | Track title currently on the Spotify player |
{spotifyArtist} | Artist or artists, comma-separated |
{spotifyAlbum} | Album name |
{spotifyProgress} | Playback position (m:ss) |
{spotifyDuration} | Track length (m:ss) |
Timers and commands
| Variable | Value |
|---|---|
{command} | Chat command on that screen (giveaway join, chat game join, point drop claim, and so on). The editor live preview uses the command you configured, not a generic !claim example. |
{duration} | Timed session length, humanized (for example 5 minutes); also Ad Break length for welcome-back |
{timeLeft} | Countdown reminder remaining time (giveaways, chat games, Ad Break pre-warnings) |
{time} | Automation cooldown time remaining, humanized |
{followage} | Formatted follow duration (for example 2y 3mo 5d 4h) |
{watchtime} | Formatted watch time (for example 2d 5h 13m) |
{login} | Twitch login for the shoutout target (used in https://twitch.tv/{login}) |
{game} | Also used by !so for the target channel's last Twitch category (not this stream's {category}) |
{track} | Spotify track title for !sr / !remove |
{artist} | Spotify artist for !sr / !remove |
{cap} | That viewer's song-request queue cap (at-cap !sr reply) |
Chat Games
Available in chat game phase, resolve, and summary messages. Dice / range games also set {roll} and {outcome}. Related: Chat Games.
| Variable | Value |
|---|---|
{totalPool} | Sum of all bets in the active chat game |
{totalPaidOut} | Total amount paid out to winners |
{totalLost} | Total bet forfeited by losers |
{entryCount} | Number of entrants |
{winnerCount} | Number of winners |
{winnersList} | Comma-separated winner display names |
{losersList} | Comma-separated loser display names |
{userStake} | Joining viewer's bet amount |
{userPayout} | Viewer's payout from the chat game |
{minBet} | Configured minimum bet (1 when no min is set) |
{maxBet} | Configured maximum bet (unlimited when no max is set) |
{acceptCommand} | Duel accept command (for example !accept) |
{declineCommand} | Duel decline command (for example !decline) |
{timeout} | Duel accept timeout in seconds |
{opponent} | Duel opponent display name (alias for {target}) |
{target} | Duel opponent display name (same as {opponent} in duel templates) |
{winner} | Duel winner display name (also wheel winning entry text) |
{loser} | Duel loser display name |
{roll} | Dice / range outcome roll for the current fire (one roll; shared by all overlapping bands) |
{outcome} | Name of the dice / range band currently running (each overlapping band sees its own name) |
Tiltify
| Variable | Value |
|---|---|
{donor} | Donor's display name |
{donationAmount} | Formatted donation amount (for example $25.00) |
{currency} | Donation currency code (for example USD) |
{goal} | Campaign goal percentage reached (for example 42%) |
{milestone} | Milestone name from the campaign |
{tiltifyReward} | Tiltify reward name claimed |
{quantity} | Reward units claimed in this donation |
Examples
- Wheel win:
Congrats {user}! The wheel landed on {winner}! You've won {count} times total ({counterTier}). - Leaderboard:
Top 5: {top5Counter:Wins}on a per-user counter - Timer / no-user per-user stat:
Wins so far: {counter:Wins}(Stats Total) - Aggregate total:
All wins combined: {counterTotal:Wins} - Goal check response:
{goalName}: {goalProgress}- for exampleSubathon Bits: 15/100 - Goal contribute success:
@{user} contributed {amount} to {goalName}! {goalProgress} ({balance} remaining) - Heist summary:
Game over! {winnerCount} got away with {totalPaidOut}. Winners: {winnersList} - Duel challenge:
{user} challenged {opponent} for {amount}! Type {acceptCommand} or {declineCommand} ({timeout}s). - Dice band:
{user} rolled {roll} ({outcome})! - Tier up: on Counter Tier Reached, prefer bare
{counterTier}for the tier that just fired
Tracking stats with counters
Counters live on Counters and Stats. Change them from Automations, wheel entry actions, Viewer Points, and related Counter Actions.
- Use global counters for stream-wide stats (deaths, total spins).
- Use per user counters to track viewer participation.
- Enable Counter Tiers on the Stats page to label milestones (Bronze / Silver / Gold, rank names, and so on).
- Show values with
{count}(first Counter Action row after a change, or on a tier trigger) or{counter:CounterName}(any counter; triggering viewer when present, otherwise the Stats Total on timers; uses this fire's post-update value when that counter was just updated). - Turn on thousands separators (1,234) per counter on Stats, Counter Options, or Create Counter so Stats and chat/alert tokens match. Off by default. Watch Time and CSV stay unchanged.
- Announce the tier a viewer just reached with
{counterTier}on a Counter Tier Reached automation; use{counterTier:CounterName}for their current tier on that counter. - Announce a per user leaderboard with
{top5Counter:CounterName}. - Show the stream-wide total (global value or sum of all per-user values) with
{counterTotal:CounterName}. - CSV import accepts comma- or semicolon-separated files (delimiter auto detected). The downloadable template stays comma-separated.
Tier milestone automation
- Enable tiers on a counter on the Stats page (threshold + label ladder).
- Create an automation with trigger Counter Tier Reached and select that counter.
- Use
{user}and{counterTier}in chat or alert text.{counterTier}is the label for this tier crossing, not the final tier if several were crossed at once.