Platform Variables

Use variables as placeholders inside Lumia messages, alerts, and overlays. Write them like {{username}} or {{amount}}, and Lumia replaces them with live data when the event runs.

Quick start

Pick a platform tab, then look in the section that matches where you want to use the variable.

• Available everywhere: broadly usable platform variables.
• Chat and commands: variables for chat messages, commands, redeems, and chatbot actions.
• Alerts and events: variables that only exist for a specific alert or event.

Examples

You write	What users see
Thanks {{username}}!	Thanks LumiaStream!
You tipped {{currencySymbol}}{{amount}}	You tipped $5
Latest message: {{message}}	Latest message: Great stream

Alert Explorer

If you are building a custom overlay, open a platform tab and use the alert explorer to inspect the exact alert name, the data.extraSettings.* fields it returns, and the matching template variables. For the full AlertEvent type, see Overlay Type Definitions.

How alert variables map to Overlay.on('alert')

In alert templates, variables like {{username}}, {{amount}}, and {{stickerName}} are the same values your overlay receives inside data.extraSettings.

In alert text / templates	In Overlay.on('alert')	Notes
{{username}}	data.extraSettings.username	Most common payload mapping.
{{amount}}	data.extraSettings.amount	Present on alerts that carry an amount.
{{stickerId}}	data.extraSettings.stickerId	Example: YouTube Super Sticker.
{{stickerName}}	data.extraSettings.stickerName	Human-readable sticker label.
Variation value	data.dynamic.value	Use this for alert variation matching, not for general overlay payload access.

Rule of thumb: if you see an alert variable on this page, read it from data.extraSettings.variableName in Overlay.on('alert').

Lumiastream

Lumiastream

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{read_file}}	Read from a file on your local computer in plain text, e.g. {{read_file=C:\User\Myfile.txt}}	{{read_file}}	Hello from notes.txt
{{read_url}}	Read from a simple GET url. This has a timeout of 2 seconds by default and will display the body of the request in plain text, e.g. {{read_url=https://api.lumiastream.com/api/url-test}}	{{read_url}}	OK
{{selection}}	Allows chat to choose based on defined selections, e.g. {{selection=first,second,third}}	{{selection}}	Option A
{{random}}	Randomly choose between two numbers, e.g. {{random=1,20}}	{{random}}	7
{{random_input}}	Randomly choose between different inputs separated by a comma, e.g. {{random_input=first,second,third}}	{{random_input}}	Blue
{{math}}	Evaluate a math expression using +, -, *, /, %, ^ and parentheses, e.g. {{math={{var1}}+{{var2}}}}	{{math}}	42
{{js}}	Evaluate a JavaScript expression in a secure sandbox, e.g. {{js=10 * {{var1}}}}	{{js}}	No example yet
{{compare}}	Compare two values and return true/false. Supports >, >=, <, <=, ==, !=, e.g. {{compare={{var1}},>,{{var2}}}}	{{compare}}	true
{{round}}	Round a number to a specific amount of decimals, e.g. {{round={{math={{var1}}/{{var2}}}},2}}	{{round}}	4
{{if}}	Return one value when true and another when false, e.g. {{if={{compare={{var1}},>,10}},high,low}}	{{if}}	Online
{{coalesce}}	Return the first non-empty value, e.g. {{coalesce={{display_name}},{{username}},Anonymous}}	{{coalesce}}	Fallback value
{{between}}	Check if a value is between min and max and return true/false, e.g. {{between={{var1}},10,50}}	{{between}}	15
{{min}}	Return the smallest numeric value from inputs, e.g. {{min={{v1}},{{v2}},100}}	{{min}}	3
{{max}}	Return the largest numeric value from inputs, e.g. {{max={{v1}},{{v2}},100}}	{{max}}	9
{{regex_extract}}	Extract text from a value using regex and group index, e.g. {{regex_extract={{message}},([0-9]+),1}}	{{regex_extract}}	12345
{{replace}}	Replace text in a value using plain text or regex, e.g. {{replace={{message}},badword,***}}	{{replace}}	Hello Lumia
{{format_date}}	Format a date/time value with a pattern, e.g. {{format_date={{session_start_date}},MM/DD/YYYY hh:mm A}}	{{format_date}}	Mar 15, 2026 9:00 AM
{{time_since}}	Return elapsed time since a date in a short format, e.g. {{time_since={{follow_time}}}}	{{time_since}}	5 minutes ago
{{sum_variables}}	Sum multiple variables together to create a combined value. This is very useful for creating a combined goal like followers, e.g. {{sum_variables=twitch_total_follower_count,kick_total_follower_count}}	{{sum_variables}}	42
{{offset_count}}	Offset the count of a variable by a number, e.g. {{offset_count=twitch_total_follower_count,10}}	{{offset_count}}	3
{{get_commands}}	Get all commands and chatbot commands that the user who triggered the command can use, e.g. {{get_commands}}	{{get_commands}}	!lights,!brb,!discord
{{get_all_commands}}	Get all commands and chatbot commands that are on e.g. {{get_all_commands}}	{{get_all_commands}}	!lights,!brb,!discord,!song
{{convert_color_to_hex}}	Converts a generic color from our colors list to hex. If the color is already hex it will keep it a hex color, e.g. {{convert_color_to_hex=green}}	{{convert_color_to_hex}}	#FF4076
{{get_latest_file_from_folder}}	Gets the latest file from a folder. e.g. {{get_latest_file_from_folder=C:/Users/Desktop}}.	{{get_latest_file_from_folder}}	/Users/name/Videos/latest.mp4
{{get_random_file_from_folder}}	Gets a random file from a folder. e.g. {{get_random_file_from_folder=C:/Users/Desktop}}.	{{get_random_file_from_folder}}	/Users/name/Videos/random.mp4
{{screenshot}}	Take a screenshot of your desktop and store it on your computer. You can also select the monitor by selecting the number after the variable. e.g. {{screenshot}}. Or to select the second monitor: {{screenshot=2}}	{{screenshot}}	https://cdn.example.com/screenshot.png
{{get_queue_count}}	The current count of items in queue. e.g. {{get_queue_count}}	{{get_queue_count}}	5
{{get_var_from_msg}}	Gets the value of a variable from a message. Use an equal sign within the message to assign a variable and a comma to separate multiple variables. e.g. !command name=lumi, age=6. var will be: {{get_var_from_msg=name}} and {{get_var_from_msg=age}}	{{get_var_from_msg}}	lumiastream
{{get_user_loyalty_points}}	Get the loyalty points value of a user. e.g. variable will be: {{get_user_loyalty_points={{message}}}}, or viewer's username and platform {{get_user_loyalty_points={{username}},{{platform}}}}. Then use it like this: !command username or !command username,platform. Result will be the point ballance without currency	{{get_user_loyalty_points}}	1250
{{translate}}	Translate a message using Google Translate. e.g. {{translate={{message}}}} or {{translate={{message}}|es}}	{{translate}}	Hello world
{{commands_url}}	Commands URL page for list of commands	{{commands_url}}	https://example.com
{{session_start_date}}	The time the session started: {{session_start_date}}	{{session_start_date}}	2026-03-15T09:00:00Z
{{game_last_player}}	Last player to trigger a game	{{game_last_player}}	Just Chatting
{{today}}	Current date without the time. Optional IANA timezone: {{today=America/New_York}}	{{today}}	No example yet
{{lumia_uptime}}	The time Lumia has been started for: {{lumia_uptime}}	{{lumia_uptime}}	2h 14m
{{lumia_uptime_timestamp}}	Timestamp of when your stream went live, e.g. {{lumia_uptime_timestamp}}	{{lumia_uptime_timestamp}}	2h 14m
{{twitch_uptime_timestamp}}	(Twitch) Live start timestamp	{{twitch_uptime_timestamp}}	2h 14m
{{youtube_uptime_timestamp}}	(YouTube) Live start timestamp	{{youtube_uptime_timestamp}}	2h 14m
{{facebook_uptime_timestamp}}	(Facebook) Live start timestamp	{{facebook_uptime_timestamp}}	2h 14m
{{kick_uptime}}	(Kick) Stream uptime	{{kick_uptime}}	2h 14m
{{kick_uptime_timestamp}}	(Kick) Live start timestamp	{{kick_uptime_timestamp}}	2h 14m
{{tiktok_uptime}}	(TikTok) Stream uptime	{{tiktok_uptime}}	2h 14m
{{tiktok_uptime_timestamp}}	(TikTok) Live start timestamp	{{tiktok_uptime_timestamp}}	2h 14m
{{overlays_brb_clips}}	Overlays brb clips urls list separated by a comma	{{overlays_brb_clips}}	No example yet
{{latest_donator}}	Last person to donate	{{latest_donator}}	lumiastream
{{latest_donator_amount}}	Last person to donate amount	{{latest_donator_amount}}	25.00
{{latest_donator_currency}}	Last person to donate currency	{{latest_donator_currency}}	USD
{{latest_donator_currency_symbol}}	Last person to donate currency symbol	{{latest_donator_currency_symbol}}	$
{{session_top_donator}}	Top person in this session to donate	{{session_top_donator}}	lumiastream
{{session_top_donator_amount}}	Top person in this session to donate amount	{{session_top_donator_amount}}	25.00
{{session_top_donator_currency}}	Top person in this session to donate currency	{{session_top_donator_currency}}	USD
{{session_top_donator_currency_symbol}}	Top person in this session to donate currency symbol	{{session_top_donator_currency_symbol}}	$
{{top_donator}}	All time top person to donate	{{top_donator}}	lumiastream
{{top_donator_amount}}	All time top person to donate amount	{{top_donator_amount}}	25.00
{{top_donator_currency}}	All time top person to donate currency	{{top_donator_currency}}	USD
{{top_donator_currency_symbol}}	All time top person to donate currency symbol	{{top_donator_currency_symbol}}	$
{{top_donator_list_amount}}	Top 10 list of people to donate amount	{{top_donator_list_amount}}	25.00
{{top_donator_list_currency}}	Top 10 list of people to donate currency	{{top_donator_list_currency}}	USD
{{top_donator_list_currency_symbol}}	Top 10 list of people to donate currency symbol	{{top_donator_list_currency_symbol}}	$
{{total_donation_amount}}	Total tips	{{total_donation_amount}}	25.00
{{total_donation_amount_currency}}	Total tips currency	{{total_donation_amount_currency}}	USD
{{total_donation_amount_currency_symbol}}	Total tips currency symbol	{{total_donation_amount_currency_symbol}}	$
{{session_donation_amount}}	Session tip	{{session_donation_amount}}	25.00
{{session_donation_amount_currency}}	Session tip currency	{{session_donation_amount_currency}}	USD
{{session_donation_amount_currency_symbol}}	Session tip currency symbol	{{session_donation_amount_currency_symbol}}	$
{{donation_count}}	All time tip count	{{donation_count}}	42
{{session_donation_count}}	Session tip count	{{session_donation_count}}	42
{{session_donator_list}}	Session donator list	{{session_donator_list}}	lumiastream,rgblumia
{{session_donator_list_with_amount}}	Session donator list with amount	{{session_donator_list_with_amount}}	25.00
{{week_donation_amount}}	Donation total for the current calendar week	{{week_donation_amount}}	25.00
{{month_donation_amount}}	Donation total for the current calendar month	{{month_donation_amount}}	25.00
{{week_donation_count}}	Donation count for the current calendar week	{{week_donation_count}}	42
{{month_donation_count}}	Donation count for the current calendar month	{{month_donation_count}}	42
{{week_top_donator}}	Top donator for the current calendar week	{{week_top_donator}}	lumiastream
{{week_top_donator_amount}}	No description available yet.	{{week_top_donator_amount}}	25.00
{{week_top_donator_list}}	Top donators this week list	{{week_top_donator_list}}	lumiastream,rgblumia
{{week_top_donator_list_amount}}	Amounts for the top donators this week list	{{week_top_donator_list_amount}}	25.00
{{month_top_donator}}	Top donator for the current calendar month	{{month_top_donator}}	lumiastream
{{month_top_donator_amount}}	No description available yet.	{{month_top_donator_amount}}	25.00
{{month_top_donator_list}}	Top donators this month list	{{month_top_donator_list}}	lumiastream,rgblumia
{{month_top_donator_list_amount}}	Amounts for the top donators this month list	{{month_top_donator_list_amount}}	25.00
{{raffle_title}}	Title of the raffle	{{raffle_title}}	Lumiastream Stream Live
{{raffle_description}}	Description of the raffle	{{raffle_description}}	Going live with alerts and lights
{{raffle_entries}}	Raffle entries list separated by comma e.g user1,user2,user3	{{raffle_entries}}	lumiastream,rgblumia
{{raffle_generated_number}}	The number that has been selected for the raffle	{{raffle_generated_number}}	No example yet
{{raffle_entries_count}}	Raffle entries count	{{raffle_entries_count}}	42
{{raffle_winners}}	All of the usernames of users who won the raffle (Comma separated)	{{raffle_winners}}	lumiastream
{{raffle_type}}	Type of raffle	{{raffle_type}}	No example yet
{{raffle_winner}}	Username of user who won the raffle	{{raffle_winner}}	lumiastream
{{raffle_winner_avatar}}	Avatar of user who won the raffle	{{raffle_winner_avatar}}	https://cdn.example.com/image.png
{{raffle_entry_command}}	Command that enters a user into the raffle	{{raffle_entry_command}}	No example yet
{{tournament_title}}	Tournament title	{{tournament_title}}	Lumiastream Stream Live
{{tournament_description}}	Tournament description	{{tournament_description}}	Going live with alerts and lights
{{tournament_game}}	Tournament game	{{tournament_game}}	Just Chatting
{{tournament_format}}	Tournament format	{{tournament_format}}	No example yet
{{tournament_state}}	Tournament state	{{tournament_state}}	No example yet
{{tournament_participants_count}}	Tournament participants count	{{tournament_participants_count}}	42
{{tournament_entry_command}}	Command used to enter the tournament	{{tournament_entry_command}}	No example yet
{{tournament_winner}}	Tournament winner	{{tournament_winner}}	lumiastream
{{tournament_winner_avatar}}	Tournament winner avatar URL	{{tournament_winner_avatar}}	https://cdn.example.com/image.png
{{viewerqueue_title}}	Viewer queue title	{{viewerqueue_title}}	Lumiastream Stream Live
{{viewerqueue_entry_command}}	Viewer queue entry command e.g: !joinq	{{viewerqueue_entry_command}}	No example yet
{{viewerqueue_entries}}	Viewer queue entries list separated by comma e.g viewer1,viewer2,viewer3	{{viewerqueue_entries}}	lumiastream,rgblumia
{{viewerqueue_players}}	Viewer queue selected players list separated by comma e.g player1,player2,player3	{{viewerqueue_players}}	lumiastream,rgblumia
{{viewerqueue_entries_count}}	Viewer queue entries count	{{viewerqueue_entries_count}}	42
{{viewerqueue_queue_limit}}	Viewer queue max entries limit	{{viewerqueue_queue_limit}}	42
{{api_action_global_response}}	Response retrieved from recently triggered api action (JSON strigified); use delay to await response	{{api_action_global_response}}	No example yet
{{last_random_input}}	The last random_input that was selected so that you can use it for things like in the end tab of commands	{{last_random_input}}	No example yet
{{loyalty_currency_name}}	The name of the loyalty currency e.g. Lumipoints	{{loyalty_currency_name}}	USD
{{now_playing_id}}	(Now Playing) Computed unique ID for the track	{{now_playing_id}}	abc123
{{now_playing_title}}	(Now Playing) Title of the track	{{now_playing_title}}	Lumiastream Stream Live
{{now_playing_artwork}}	(Now Playing) Song art work	{{now_playing_artwork}}	https://cdn.example.com/image.png
{{now_playing_artist}}	(Now Playing) Artist	{{now_playing_artist}}	No example yet
{{now_playing_album}}	(Now Playing) Album	{{now_playing_album}}	No example yet
{{now_playing_label}}	(Now Playing) Record label	{{now_playing_label}}	No example yet
{{now_playing_bpm}}	(Now Playing) Original BPM of the song	{{now_playing_bpm}}	128
{{now_playing_rating}}	(Now Playing) Rating	{{now_playing_rating}}	5
{{now_playing_length}}	(Now Playing) Length of song in seconds	{{now_playing_length}}	03:45
{{now_playing_comment}}	(Now Playing) Comment	{{now_playing_comment}}	Now playing
{{now_playing_key}}	(Now Playing) Key signature	{{now_playing_key}}	C#m
{{now_playing_url}}	(Now Playing) The Beatport or Spotify URL of the song	{{now_playing_url}}	https://example.com
{{now_playing_spotify_url}}	(Now Playing) Spotify URL	{{now_playing_spotify_url}}	https://open.spotify.com/track/abc123
{{now_playing_beatport_url}}	(Now Playing) Beatport track URL	{{now_playing_beatport_url}}	https://www.beatport.com/track/example/123456
{{now_playing_beatport_id}}	(Now Playing) Beatport track ID	{{now_playing_beatport_id}}	abc123
{{now_playing_file_path}}	(Now Playing) Path to media	{{now_playing_file_path}}	/Users/name/Music/song.mp3
{{heartrate_bpm}}	(Pulsoid/Hyperate) BPM of your heart	{{heartrate_bpm}}	128
{{follower_goal}}	Follower goal target imported from StreamElements	{{follower_goal}}	lumiastream
{{subscriber_goal}}	Subscriber goal target imported from StreamElements	{{subscriber_goal}}	lumiastream
{{cheer_goal}}	Cheer/bits goal target imported from StreamElements	{{cheer_goal}}	No example yet
{{tip_goal}}	Tip/donation goal target imported from StreamElements	{{tip_goal}}	No example yet
{{superchat_goal}}	Superchat goal target imported from StreamElements	{{superchat_goal}}	No example yet
{{merch_goal_orders}}	Merch order count goal imported from StreamElements	{{merch_goal_orders}}	No example yet
{{merch_goal_items}}	Merch item count goal imported from StreamElements	{{merch_goal_items}}	No example yet
{{merch_goal_total}}	Merch revenue goal imported from StreamElements	{{merch_goal_total}}	No example yet
{{session_top_tipper}}	Top tipper this session (cumulative giver)	{{session_top_tipper}}	No example yet
{{session_top_tipper_amount}}	Amount donated by the session top tipper	{{session_top_tipper_amount}}	25.00
{{week_top_tipper}}	Top tipper this week (cumulative giver)	{{week_top_tipper}}	No example yet
{{week_top_tipper_amount}}	Amount donated by the week top tipper	{{week_top_tipper_amount}}	25.00
{{month_top_tipper}}	Top tipper this month (cumulative giver)	{{month_top_tipper}}	No example yet
{{month_top_tipper_amount}}	Amount donated by the month top tipper	{{month_top_tipper_amount}}	25.00
{{alltime_top_tipper}}	All-time top tipper (cumulative giver)	{{alltime_top_tipper}}	No example yet
{{alltime_top_tipper_amount}}	Amount donated by the all-time top tipper	{{alltime_top_tipper_amount}}	25.00
{{last_charity_donator}}	Latest charity-campaign donor name	{{last_charity_donator}}	lumiastream
{{last_charity_donation_amount}}	Amount of the latest charity donation	{{last_charity_donation_amount}}	25.00
{{session_top_charity_donation}}	Largest single charity donation this session	{{session_top_charity_donation}}	No example yet
{{session_top_charity_donation_amount}}	Amount of the largest single session charity donation	{{session_top_charity_donation_amount}}	25.00
{{week_top_charity_donation}}	Largest single charity donation this week	{{week_top_charity_donation}}	No example yet
{{week_top_charity_donation_amount}}	Amount of the largest single week charity donation	{{week_top_charity_donation_amount}}	25.00
{{month_top_charity_donation}}	Largest single charity donation this month	{{month_top_charity_donation}}	No example yet
{{month_top_charity_donation_amount}}	Amount of the largest single month charity donation	{{month_top_charity_donation_amount}}	25.00
{{alltime_top_charity_donation}}	Largest single charity donation all-time	{{alltime_top_charity_donation}}	No example yet
{{alltime_top_charity_donation_amount}}	Amount of the largest single all-time charity donation	{{alltime_top_charity_donation_amount}}	25.00
{{session_top_charity_donator}}	Top charity donor this session (cumulative giver)	{{session_top_charity_donator}}	lumiastream
{{session_top_charity_donator_amount}}	Amount donated by the session top charity donor	{{session_top_charity_donator_amount}}	25.00
{{week_top_charity_donator}}	Top charity donor this week (cumulative giver)	{{week_top_charity_donator}}	lumiastream
{{week_top_charity_donator_amount}}	Amount donated by the week top charity donor	{{week_top_charity_donator_amount}}	25.00
{{month_top_charity_donator}}	Top charity donor this month (cumulative giver)	{{month_top_charity_donator}}	lumiastream
{{month_top_charity_donator_amount}}	Amount donated by the month top charity donor	{{month_top_charity_donator_amount}}	25.00
{{alltime_top_charity_donator}}	All-time top charity donor (cumulative giver)	{{alltime_top_charity_donator}}	lumiastream
{{alltime_top_charity_donator_amount}}	Amount donated by the all-time top charity donor	{{alltime_top_charity_donator_amount}}	25.00
{{week_top_cheer}}	Largest single cheer this week	{{week_top_cheer}}	No example yet
{{week_top_cheer_amount}}	Bit amount for the largest single week cheer	{{week_top_cheer_amount}}	25.00
{{month_top_cheer}}	Largest single cheer this month	{{month_top_cheer}}	No example yet
{{month_top_cheer_amount}}	Bit amount for the largest single month cheer	{{month_top_cheer_amount}}	25.00
{{alltime_top_cheer}}	Largest single cheer all-time	{{alltime_top_cheer}}	No example yet
{{alltime_top_cheer_amount}}	Bit amount for the largest single all-time cheer	{{alltime_top_cheer_amount}}	25.00
{{recent_followers}}	Comma-separated list of recent followers	{{recent_followers}}	lumiastream
{{recent_subscribers}}	Comma-separated list of recent subscribers	{{recent_subscribers}}	lumiastream,rgblumia
{{recent_hosts}}	Comma-separated list of recent hosts	{{recent_hosts}}	No example yet
{{recent_raiders}}	Comma-separated list of recent raiders	{{recent_raiders}}	lumiastream
{{recent_raiders_amount}}	Parallel comma-separated viewer counts for recent raiders	{{recent_raiders_amount}}	25.00
{{recent_cheers}}	Comma-separated list of recent cheerers	{{recent_cheers}}	No example yet
{{recent_cheers_amount}}	Parallel comma-separated bit amounts for recent cheerers	{{recent_cheers_amount}}	25.00
{{recent_tips}}	Comma-separated list of recent tippers	{{recent_tips}}	No example yet
{{recent_tips_amount}}	Parallel comma-separated tip amounts for recent tippers	{{recent_tips_amount}}	25.00
{{recent_superchats}}	Comma-separated list of recent superchatters	{{recent_superchats}}	No example yet
{{recent_superchats_amount}}	Parallel comma-separated superchat amounts for recent superchatters	{{recent_superchats_amount}}	25.00
{{recent_charity_donations}}	Comma-separated list of recent charity donors	{{recent_charity_donations}}	No example yet
{{recent_charity_donations_amount}}	Parallel comma-separated donation amounts for recent charity donors	{{recent_charity_donations_amount}}	25.00

Chat and commands

Use these when building chat responses, command replies, redeems, or chatbot actions.

Chatbot command (22)

Variable	Meaning	Use it like
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Chat match (5)

Variable	Meaning	Use it like
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{language_detect_result}}	The language detection result will display either the default message or the translated message, depending on the action selected from the 'Action to Do' dropdown menu	{{language_detect_result}}
{{detected_language}}	The language of the written chat message, such as English, Spanish, etc.	{{detected_language}}
{{detected_language_code}}	The language code of the written chat message, such as en, es, etc.	{{detected_language_code}}

Chat command (24)

Variable	Meaning	Use it like
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}
{{points_cost}}	Loyalty Points command cost	{{points_cost}}
{{voice_command_full_sentence}}	The full sentence that was picked up when a voice command has been triggered	{{voice_command_full_sentence}}

Kick points (16)

Variable	Meaning	Use it like
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{prompt}}	The users message that was prompted	{{prompt}}
{{message}}	The message text sent by the user	{{message}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{points}}	(Twitch) How many points were used for a Twitch Point redemption	{{points}}
{{title}}	The title of the Twitch Redemption that was redeemed	{{title}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Twitch extension redeem (16)

Variable	Meaning	Use it like
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{prompt}}	The users message that was prompted	{{prompt}}
{{message}}	The message text sent by the user	{{message}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{bits}}	(Twitch) How many bits were used with the Twitch Extension redemption	{{bits}}
{{timestamp}}	The time the command was triggered	{{timestamp}}
{{points_cost}}	Loyalty Points command cost	{{points_cost}}

Twitch channel points (16)

Variable	Meaning	Use it like
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{prompt}}	The users message that was prompted	{{prompt}}
{{message}}	The message text sent by the user	{{message}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{points}}	(Twitch) How many points were used for a Twitch Point redemption	{{points}}
{{title}}	The title of the Twitch Redemption that was redeemed	{{title}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Aichat (19)

Variable	Meaning	Use it like
{{ai_response}}	No description available yet.	{{ai_response}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Commands (24)

Variable	Meaning	Use it like
{{get_all_commands}}	Get all commands and chatbot commands that are on e.g. {{get_all_commands}}	{{get_all_commands}}
{{get_commands}}	Get all commands and chatbot commands that the user who triggered the command can use, e.g. {{get_commands}}	{{get_commands}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{originType}}	No description available yet.	{{originType}}
{{queueType}}	No description available yet.	{{queueType}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{messageWithoutEmotes}}	The message that the sender sent without the command/alias and without emots inside of the message. Mainly used for TTS.	{{messageWithoutEmotes}}
{{rawMessageWithoutEmotes}}	The raw message that the sender sent without emotes inside of the message	{{rawMessageWithoutEmotes}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Cooldowns (1)

Variable	Meaning	Use it like
{{cooldown_time_remaining}}	The time remaining for a cooldown in seconds	{{cooldown_time_remaining}}

Duel (24)

Variable	Meaning	Use it like
{{duel_result}}	The Duel result will display a winning, losing, or invalid input message based on the game status	{{duel_result}}
{{duel_winner}}	The username of the duel winner	{{duel_winner}}
{{duel_loser}}	The username of the duel loser	{{duel_loser}}
{{duel_target_username}}	Target is the one who was been challenged for a duel	{{duel_target_username}}
{{duel_duration}}	Duel duration	{{duel_duration}}
{{outcome_amount}}	The outcome amount is the total won or lost during a game.	{{outcome_amount}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

File Watcher (4)

Variable	Meaning	Use it like
{{content}}	Content of the watched file	{{content}}
{{file}}	Path of the watched file	{{file}}
{{path}}	Path of the watched file	{{path}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Followage (19)

Variable	Meaning	Use it like
{{follow_time}}	No description available yet.	{{follow_time}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Loyalty Points (23)

Variable	Meaning	Use it like
{{points_balance}}	Loyalty Points balance for this user. Can only be used in the !points chatbot command	{{points_balance}}
{{user_rank}}	The user's position in the loyalty points ranking list. For example, rank 4 means the user is in the 4th position in the loyalty points list.	{{user_rank}}
{{total_rank}}	The total number of users in the loyalty points list. For example, 125 users. This can be used with the {{user_rank}} variable. For example, the username's rank is 3 out of a total of 125 users.	{{total_rank}}
{{loyalty_currency_name}}	The name of the loyalty currency e.g. Lumipoints	{{loyalty_currency_name}}
{{get_user_loyalty_points}}	Get the loyalty points value of a user. e.g. variable will be: {{get_user_loyalty_points={{message}}}}, or viewer's username and platform {{get_user_loyalty_points={{username}},{{platform}}}}. Then use it like this: !command username or !command username,platform. Result will be the point ballance without currency	{{get_user_loyalty_points}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Raffle Entry (28)

Variable	Meaning	Use it like
{{raffle_title}}	Title of the raffle	{{raffle_title}}
{{raffle_description}}	Description of the raffle	{{raffle_description}}
{{raffle_entries}}	Raffle entries list separated by comma e.g user1,user2,user3	{{raffle_entries}}
{{raffle_generated_number}}	The number that has been selected for the raffle	{{raffle_generated_number}}
{{raffle_entries_count}}	Raffle entries count	{{raffle_entries_count}}
{{raffle_winners}}	All of the usernames of users who won the raffle (Comma separated)	{{raffle_winners}}
{{raffle_type}}	Type of raffle	{{raffle_type}}
{{raffle_winner}}	Username of user who won the raffle	{{raffle_winner}}
{{raffle_winner_avatar}}	Avatar of user who won the raffle	{{raffle_winner_avatar}}
{{raffle_entry_command}}	Command that enters a user into the raffle	{{raffle_entry_command}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Roulette (21)

Variable	Meaning	Use it like
{{roulette_result}}	The roulette result will display a winning, losing, or invalid input message based on the game status	{{roulette_result}}
{{ball_position}}	The position where the ball lands in a game.	{{ball_position}}
{{outcome_amount}}	The outcome amount is the total won or lost during a game.	{{outcome_amount}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Shoutout (43)

Variable	Meaning	Use it like
{{clip_shoutout_url}}	shoutout_video_url	{{clip_shoutout_url}}
{{clip_title}}	Clip's title	{{clip_title}}
{{clip_url}}	clip_url	{{clip_url}}
{{clip_target_username}}	Target user's username from the clip	{{clip_target_username}}
{{clip_target_userid}}	Target user's ID from the clip	{{clip_target_userid}}
{{clip_target_avatar}}	Target user's avatar from the clip	{{clip_target_avatar}}
{{clip_thumbnail_url}}	Clip's thumbnail URL	{{clip_thumbnail_url}}
{{clip_duration}}	Clip's duration	{{clip_duration}}
{{clip_target_channel}}	Target user's channel link	{{clip_target_channel}}
{{clip_embed_url}}	Clip's embed URL	{{clip_embed_url}}
{{clip_id}}	ID of the clip	{{clip_id}}
{{clip_creator_id}}	Clip creators ID from the clip	{{clip_creator_id}}
{{clip_creator_name}}	Clip creators name from the clip	{{clip_creator_name}}
{{clip_game_id}}	Clip's game ID	{{clip_game_id}}
{{clip_language}}	Clip's language	{{clip_language}}
{{clip_view_count}}	Clip's view count	{{clip_view_count}}
{{clip_created_at}}	Date clip was created	{{clip_created_at}}
{{clip_target_displayname}}	Target's display name	{{clip_target_displayname}}
{{clip_target_language}}	Target's language	{{clip_target_language}}
{{clip_target_category_id}}	Target's category id	{{clip_target_category_id}}
{{clip_target_category}}	Target's category	{{clip_target_category}}
{{current_target_category_id}}	No description available yet.	{{current_target_category_id}}
{{current_target_category}}	No description available yet.	{{current_target_category}}
{{clip_target_channel_title}}	Target's current or last stream title	{{clip_target_channel_title}}
{{clip_target_channel_tags}}	Target's current or last stream tags	{{clip_target_channel_tags}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Slots (21)

Variable	Meaning	Use it like
{{slots_result}}	The slots result will display a winning, losing, or invalid input message based on the game status	{{slots_result}}
{{slots_combo}}	The slots roll combination e.g. ⭐️ ⭐️ ⭐️ or 🍒 🍒 🍒	{{slots_combo}}
{{outcome_amount}}	The outcome amount is the total won or lost during a game.	{{outcome_amount}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Uptime (19)

Variable	Meaning	Use it like
{{uptime}}	The time your stream has been started for: {{uptime}}	{{uptime}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Viewer Queue Entry (24)

Variable	Meaning	Use it like
{{viewerqueue_title}}	Viewer queue title	{{viewerqueue_title}}
{{viewerqueue_entry_command}}	Viewer queue entry command e.g: !joinq	{{viewerqueue_entry_command}}
{{viewerqueue_entries}}	Viewer queue entries list separated by comma e.g viewer1,viewer2,viewer3	{{viewerqueue_entries}}
{{viewerqueue_players}}	Viewer queue selected players list separated by comma e.g player1,player2,player3	{{viewerqueue_players}}
{{viewerqueue_entries_count}}	Viewer queue entries count	{{viewerqueue_entries_count}}
{{viewerqueue_queue_limit}}	Viewer queue max entries limit	{{viewerqueue_queue_limit}}
{{username}}	The username of the sender	{{username}}
{{displayname}}	The display name of the sender	{{displayname}}
{{userId}}	The user ID of the sender	{{userId}}
{{avatar}}	The url of the avatar of the sender for a message	{{avatar}}
{{userLevels}}	The user levels of the sender for a message. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevels.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevels}}
{{userLevelsRaw}}	The raw user levels of the sender for a message in object format. Contains: broadcaster, moderator, vip, tier3, tier2, subscriber, regular, follower, anyone. Example: {{userLevelsRaw.subscriber}} to check if the user is a subscriber. Returns true or false	{{userLevelsRaw}}
{{channelDescription}}	The description of the target channel	{{channelDescription}}
{{channelViews}}	Amount of views the target channel has	{{channelViews}}
{{command}}	The command that was triggered for the message	{{command}}
{{message}}	The message text sent by the user	{{message}}
{{messageId}}	The ID of the message	{{messageId}}
{{userColor}}	(Twitch) The hex color of the sender for a Twitch message, e.g. #FF00FF	{{userColor}}
{{platform}}	The streaming platform this message is coming from	{{platform}}
{{badgesRaw}}	The raw badges for the message	{{badgesRaw}}
{{hasEmotes}}	Whether or not a message contains an emote	{{hasEmotes}}
{{emotes}}	emotes that were sent inside of a message. It will look like: ID:Name,ID:Name	{{emotes}}
{{emotesRaw}}	The raw emotes that were used for a message	{{emotesRaw}}
{{timestamp}}	The time the command was triggered	{{timestamp}}

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Lumiastream

Live preview

Alert: lumiastream-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "lumiastream-donation"

extraSettings {7}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

sender_social_link: "https://twitch.tv/lumiastream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

anonymous: false

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message	https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png
{{sender_social_link}}	data.extraSettings.sender_social_link	No description available yet.	https://twitch.tv/lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300
{{message}}	data.extraSettings.message	The message text sent by the user	Great Stream
{{anonymous}}	data.extraSettings.anonymous	No description available yet.	false
{{command}}	data.extraSettings.command	The command that was triggered for the message	No example yet

Crowdcontrol

Crowdcontrol

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Crowdcontrol

Live preview

Alert: crowdcontrol-effect

Message template: {{username}} sent {{effect}}

Example scenario

Overlay payload explorer

data {4}

alert: "crowdcontrol-effect"

extraSettings {7}

username: "lumiastream"

effect: "Big Light"

game: "Lumia Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

artwork: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

message: "Turn on the lights"

duration: 5

fromLumia: true

dynamic {1}

value: "Big Light"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{displayname}}	data.extraSettings.displayname	The display name of the sender	No example yet
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message	https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png
{{platform}}	data.extraSettings.platform	The streaming platform this message is coming from	No example yet
{{effect}}	data.extraSettings.effect	No description available yet.	Big Light
{{effectId}}	data.extraSettings.effectId	No description available yet.	No example yet
{{game}}	data.extraSettings.game	No description available yet.	Lumia Stream
{{gameId}}	data.extraSettings.gameId	No description available yet.	No example yet
{{artwork}}	data.extraSettings.artwork	No description available yet.	https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png
{{message}}	data.extraSettings.message	The message text sent by the user	Turn on the lights
{{duration}}	data.extraSettings.duration	No description available yet.	5

Discord

Discord

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Discord

Live preview

Alert: discord-entrance

Message template: Welcome {{username}}

Overlay payload explorer

data {3}

alert: "discord-entrance"

extraSettings {0}

fromLumia: true

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	No example yet
{{userId}}	data.extraSettings.userId	The user ID of the sender	No example yet
{{displayname}}	data.extraSettings.displayname	The display name of the sender	No example yet
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message	No example yet
{{message}}	data.extraSettings.message	The message text sent by the user	No example yet

Donordrive

Donordrive

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{donordrive_goal_amount}}	DonorDrive campaign goal amount	{{donordrive_goal_amount}}	25.00
{{donordrive_total_raised}}	Total amount raised for the DonorDrive campaign	{{donordrive_total_raised}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Donordrive

Live preview

Alert: donordrive-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "donordrive-donation"

extraSettings {5}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Extralife

Extralife

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{extralife_goal_amount}}	Extra Life campaign goal amount	{{extralife_goal_amount}}	25.00
{{extralife_total_raised}}	Total amount raised for the Extra Life campaign	{{extralife_total_raised}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Extralife

Live preview

Alert: extralife-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "extralife-donation"

extraSettings {5}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Facebook

Facebook

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{facebook_uptime}}	(Facebook) The time your Facebook Live stream has been started for: {{facebook_uptime}}	{{facebook_uptime}}	2h 14m
{{facebook_live}}	(Facebook) Whether your Facebook Live stream is live: {{facebook_live}}	{{facebook_live}}	true
{{facebook_session_chat_count}}	(Facebook) the total chats received since Lumia Stream has turned on	{{facebook_session_chat_count}}	42
{{facebook_current_first_chatter}}	(Facebook) the first user who chatted	{{facebook_current_first_chatter}}	lumiastream
{{facebook_current_first_chatter_count}}	(Facebook) current first chatter count	{{facebook_current_first_chatter_count}}	42
{{facebook_previous_first_chatter}}	(Facebook) previous first chatter	{{facebook_previous_first_chatter}}	lumiastream
{{facebook_previous_first_chatter_count}}	(Facebook) previous first chatter count	{{facebook_previous_first_chatter_count}}	42
{{facebook_last_chatter}}	(Facebook) the last user who chatted	{{facebook_last_chatter}}	lumiastream
{{facebook_total_follower_count}}	(Facebook) the total follower count for your page	{{facebook_total_follower_count}}	42
{{facebook_session_follower_count}}	(Facebook) the total follower count for your page for this session	{{facebook_session_follower_count}}	42
{{facebook_week_follower_count}}	(Facebook) Followers this calendar week	{{facebook_week_follower_count}}	42
{{facebook_month_follower_count}}	(Facebook) Followers this calendar month	{{facebook_month_follower_count}}	42
{{facebook_total_fan_count}}	(Facebook) total fan count	{{facebook_total_fan_count}}	42
{{facebook_session_fan_count}}	(Facebook) session fan count	{{facebook_session_fan_count}}	42
{{facebook_week_fan_count}}	(Facebook) Page fans this calendar week	{{facebook_week_fan_count}}	42
{{facebook_month_fan_count}}	(Facebook) Page fans this calendar month	{{facebook_month_fan_count}}	42
{{facebook_reaction_count}}	(Facebook) the reactions your live video has received for this session	{{facebook_reaction_count}}	42
{{facebook_last_star}}	(Facebook) the last user to send stars	{{facebook_last_star}}	No example yet
{{facebook_last_star_amount}}	(Facebook) the last user to send stars amount	{{facebook_last_star_amount}}	25.00
{{facebook_session_stars}}	(Facebook) Session stars list	{{facebook_session_stars}}	No example yet
{{facebook_session_stars_with_amount}}	(Facebook) Session stars list with amount	{{facebook_session_stars_with_amount}}	25.00

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Facebook

Live preview

Alert: facebook-entrance

Message template: Welcome {{username}}

Overlay payload explorer

data {3}

alert: "facebook-entrance"

extraSettings {0}

fromLumia: true

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	No example yet
{{message}}	data.extraSettings.message	The message text sent by the user	No example yet

Fourthwall

Fourthwall

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Fourthwall

Live preview

Alert: fourthwall-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "fourthwall-donation"

extraSettings {4}

username: "lumiastream"

amount: 100

currency: "USD"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{email}}	data.extraSettings.email	Email of user	No example yet
{{message}}	data.extraSettings.message	The message text sent by the user	No example yet
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300
{{id}}	data.extraSettings.id	No description available yet.	No example yet
{{status}}	data.extraSettings.status	No description available yet.	No example yet
{{createdAt}}	data.extraSettings.createdAt	No description available yet.	No example yet
{{updatedAt}}	data.extraSettings.updatedAt	No description available yet.	No example yet
{{raw}}	data.extraSettings.raw	The raw data that comes in through the platform for the alert. This is useful for custom code when data is needed that we don't provide by default.	No example yet

Kick

Kick

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{kick_user_id}}	(Kick) the user id of the streamer	{{kick_user_id}}	abc123
{{kick_username}}	(Kick) the username of the streamer	{{kick_username}}	lumiastream
{{kick_channel_title}}	(Kick) the title of the channel	{{kick_channel_title}}	Kick Stream Live
{{kick_channel_description}}	(Kick) the description of the channel	{{kick_channel_description}}	Going live with alerts and lights
{{kick_avatar}}	(Kick) the avatar of the channel	{{kick_avatar}}	https://cdn.example.com/image.png
{{kick_category}}	(Kick) the category the stream is in	{{kick_category}}	Just Chatting
{{kick_category_id}}	(Kick) the category id the stream is in	{{kick_category_id}}	Just Chatting
{{kick_live}}	(Kick) Whether your Kick Live stream is live: {{kick_live}}	{{kick_live}}	true
{{kick_get_avatar={{message}}}}	No description available yet.	{{kick_get_avatar={{message}}}}	https://cdn.example.com/image.png
{{kick_stream_title}}	(Kick) the title of the stream	{{kick_stream_title}}	Kick Stream Live
{{kick_session_chat_count}}	(Kick) the total chats received since Lumia Stream has turned on	{{kick_session_chat_count}}	42
{{kick_current_first_chatter}}	(Kick) the first user who chatted	{{kick_current_first_chatter}}	lumiastream
{{kick_current_first_chatter_count}}	(Kick) current first chatter count	{{kick_current_first_chatter_count}}	42
{{kick_previous_first_chatter}}	(Kick) previous first chatter	{{kick_previous_first_chatter}}	lumiastream
{{kick_previous_first_chatter_count}}	(Kick) previous first chatter count	{{kick_previous_first_chatter_count}}	42
{{kick_last_chatter}}	(Kick) the last user who chatted	{{kick_last_chatter}}	lumiastream
{{kick_current_viewer_count}}	(Kick) the current views on your live video	{{kick_current_viewer_count}}	42
{{kick_total_follower_count}}	(Kick) the total follower count of your channel	{{kick_total_follower_count}}	42
{{kick_session_follower_count}}	(Kick) the followers received in this session	{{kick_session_follower_count}}	42
{{kick_week_follower_count}}	(Kick) Followers this calendar week	{{kick_week_follower_count}}	42
{{kick_month_follower_count}}	(Kick) Followers this calendar month	{{kick_month_follower_count}}	42
{{kick_total_subscriber_count}}	(Kick) the total subscriber count of your channel	{{kick_total_subscriber_count}}	42
{{kick_session_subscriber_count}}	(Kick) the count of subscribers received in this session	{{kick_session_subscriber_count}}	42
{{kick_week_subscriber_count}}	(Kick) Subscribers this calendar week	{{kick_week_subscriber_count}}	42
{{kick_month_subscriber_count}}	(Kick) Subscribers this calendar month	{{kick_month_subscriber_count}}	42
{{kick_session_gifts_count}}	(Kick) the total gifts received in this session	{{kick_session_gifts_count}}	42
{{kick_session_subscribers}}	(Kick) the subscribers received in this session	{{kick_session_subscribers}}	lumiastream,rgblumia
{{kick_last_kicks}}	(Kick) the last kicks that were sent	{{kick_last_kicks}}	No example yet
{{kick_last_kicks_amount}}	(Kick) the amount of the last kicks that were sent	{{kick_last_kicks_amount}}	25.00
{{kick_total_kicks_count}}	(Kick) the total kicks count of your Kick channel	{{kick_total_kicks_count}}	42
{{kick_session_kicks_count}}	(Kick) the total kicks received since Lumia Stream has turned on	{{kick_session_kicks_count}}	42
{{kick_session_kicks}}	(Kick) Session kicks list	{{kick_session_kicks}}	No example yet
{{kick_session_kicks_with_amount}}	(Kick) Session kicks list with amount	{{kick_session_kicks_with_amount}}	25.00
{{kick_last_follower}}	(Kick) the last user who followed you	{{kick_last_follower}}	lumiastream
{{kick_last_subscriber}}	(Kick) the last user who subscribed	{{kick_last_subscriber}}	lumiastream
{{kick_last_gifter}}	(Kick) Last user who sent a gift subscription	{{kick_last_gifter}}	No example yet
{{kick_last_gifter_amount}}	No description available yet.	{{kick_last_gifter_amount}}	25.00
{{kick_last_gifted}}	(Kick) Last gifted subscription recipient	{{kick_last_gifted}}	No example yet
{{kick_last_host}}	(Kick) the last user who hosted you	{{kick_last_host}}	No example yet
{{kick_last_host_amount}}	No description available yet.	{{kick_last_host_amount}}	25.00
{{kick_total_gift_subscription_count}}	(Kick) the total gift subscription count of your Kick channel	{{kick_total_gift_subscription_count}}	42
{{kick_get_avatar}}	(Kick) Get a user's avatar by username	{{kick_get_avatar}}	https://cdn.example.com/image.png

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Kick

Live preview

Alert: kick-banned

Message template: {{username}} is banned

Example scenario

Overlay payload explorer

data {4}

alert: "kick-banned"

extraSettings {3}

username: "lumiastream"

bannedByUsername: "lumiacove"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {1}

value: "lumiastream"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{userId}}	data.extraSettings.userId	The user ID of the sender	No example yet
{{bannedByUsername}}	data.extraSettings.bannedByUsername	No description available yet.	lumiacovelumiastream
{{bannedByUserId}}	data.extraSettings.bannedByUserId	No description available yet.	No example yet
{{expires}}	data.extraSettings.expires	No description available yet.	No example yet

Kofi

Kofi

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{kofi_last_order_name}}	(KOFI) the last person who ordered an item's name	{{kofi_last_order_name}}	No example yet
{{kofi_last_order_amount}}	(KOFI) the amount for the last order that was made	{{kofi_last_order_amount}}	25.00
{{kofi_last_order_amount_currency}}	(KOFI) the currency of the amount for the last order that was made	{{kofi_last_order_amount_currency}}	USD

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Kofi

Live preview

Alert: kofi-commission

Message template: {{username}} just commisioned with amount {{amount}}

Example scenario

Overlay payload explorer

data {4}

alert: "kofi-commission"

extraSettings {4}

username: "lumiastream"

amount: 100

currency: "USD"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{email}}	data.extraSettings.email	Email of user	No example yet
{{currency}}	data.extraSettings.currency	The currency used	USD
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Meld

Meld

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Meld

Live preview

Alert: meld-recordingStarting

Message template: {{name}} is starting

Example scenario

Overlay payload explorer

data {4}

alert: "meld-recordingStarting"

extraSettings {0}

fromLumia: true

dynamic {1}

value: "Go Bright"

No fields available for Meld-Recording Starting.

Nowplaying

Nowplaying

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{now_playing_id}}	(Now Playing) Computed unique ID for the track	{{now_playing_id}}	abc123
{{now_playing_title}}	(Now Playing) Title of the track	{{now_playing_title}}	Nowplaying Stream Live
{{now_playing_artwork}}	(Now Playing) Song art work	{{now_playing_artwork}}	https://cdn.example.com/image.png
{{now_playing_artist}}	(Now Playing) Artist	{{now_playing_artist}}	No example yet
{{now_playing_album}}	(Now Playing) Album	{{now_playing_album}}	No example yet
{{now_playing_label}}	(Now Playing) Record label	{{now_playing_label}}	No example yet
{{now_playing_bpm}}	(Now Playing) Original BPM of the song	{{now_playing_bpm}}	128
{{now_playing_rating}}	(Now Playing) Rating	{{now_playing_rating}}	5
{{now_playing_length}}	(Now Playing) Length of song in seconds	{{now_playing_length}}	03:45
{{now_playing_comment}}	(Now Playing) Comment	{{now_playing_comment}}	Now playing
{{now_playing_key}}	(Now Playing) Key signature	{{now_playing_key}}	C#m
{{now_playing_url}}	(Now Playing) The Beatport or Spotify URL of the song	{{now_playing_url}}	https://example.com
{{now_playing_spotify_url}}	(Now Playing) Spotify URL	{{now_playing_spotify_url}}	https://open.spotify.com/track/abc123
{{now_playing_beatport_url}}	(Now Playing) Beatport track URL	{{now_playing_beatport_url}}	https://www.beatport.com/track/example/123456
{{now_playing_beatport_id}}	(Now Playing) Beatport track ID	{{now_playing_beatport_id}}	abc123
{{now_playing_file_path}}	(Now Playing) Path to media	{{now_playing_file_path}}	/Users/name/Music/song.mp3

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Nowplaying

Live preview

Alert: nowplaying-switchSong

Message template: Song switched to {{title}}

Example scenario

Overlay payload explorer

data {4}

alert: "nowplaying-switchSong"

extraSettings {5}

title: "Lumia Dream"

artist: "Lumia Stream"

artwork: "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj"

url: "https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f"

image: "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj"

fromLumia: true

dynamic {1}

value: "Lumia Dream"

Template variable	Overlay path	Meaning	Example values
{{id}}	data.extraSettings.id	No description available yet.	No example yet
{{title}}	data.extraSettings.title	The title of the Twitch Redemption that was redeemed	Lumia Dreamlumiastream
{{artwork}}	data.extraSettings.artwork	No description available yet.	https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj
{{artist}}	data.extraSettings.artist	No description available yet.	Lumia Streamlumiastream
{{album}}	data.extraSettings.album	No description available yet.	No example yet
{{label}}	data.extraSettings.label	No description available yet.	No example yet
{{bpm}}	data.extraSettings.bpm	No description available yet.	No example yet
{{rating}}	data.extraSettings.rating	No description available yet.	No example yet
{{length}}	data.extraSettings.length	Length of time in seconds	No example yet
{{comment}}	data.extraSettings.comment	No description available yet.	No example yet
{{key}}	data.extraSettings.key	No description available yet.	No example yet
{{url}}	data.extraSettings.url	No description available yet.	https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f
{{spotify_url}}	data.extraSettings.spotify_url	No description available yet.	No example yet
{{beatport_url}}	data.extraSettings.beatport_url	No description available yet.	No example yet
{{beatport_id}}	data.extraSettings.beatport_id	No description available yet.	No example yet
{{file_key}}	data.extraSettings.file_key	No description available yet.	No example yet

Obs

Obs

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{obs_screenshot}}	Take a screenshot of the current obs scene and store it on your computer. You can also select any scene by selecting the scene after the variable. e.g. {{obs_screenshot}}. Or to select the scene: {{obs_screenshot=scene1}}	{{obs_screenshot}}	No example yet
{{obs_replay}}	Save a replay from your buffer and store it on your computer. Sometimes replaying takes a bit longer so you can set how many seconds to wait before trying to retireve the buffer also. Mainly used with Twitter. e.g. {{obs_replay}}. Or to set how many seconds to wait {{obs_replay=5}}.	{{obs_replay}}	No example yet
{{obs_vertical_replay}}	Save a replay from your vertical buffer and store it on your computer. Sometimes replaying takes a bit longer so you can set how many seconds to wait before trying to retireve the buffer also. Mainly used with Tiktok. e.g. {{obs_vertical_replay}}. Or to set how many seconds to wait {{obs_vertical_replay=5}}.	{{obs_vertical_replay}}	No example yet
{{obs_is_streaming}}	(OBS) is streaming (true or false)	{{obs_is_streaming}}	No example yet
{{obs_is_recording}}	(OBS) is recording (true or false)	{{obs_is_recording}}	No example yet
{{obs_last_recording_path}}	(OBS) last recording path	{{obs_last_recording_path}}	No example yet
{{obs_studio_mode}}	(OBS) studio mode is on (true or false)	{{obs_studio_mode}}	No example yet
{{obs_current_profile}}	(OBS) current profile	{{obs_current_profile}}	No example yet
{{obs_current_scene}}	(OBS) current scene	{{obs_current_scene}}	No example yet
{{obs_previous_scene}}	(OBS) previous scene	{{obs_previous_scene}}	No example yet
{{obs_current_transition}}	(OBS) current transition if it is transitioning	{{obs_current_transition}}	No example yet
{{obs_last_replay_buffer_path}}	(OBS) Last saved replay buffer path	{{obs_last_replay_buffer_path}}	No example yet
{{obs_last_vertical_backtrack_path}}	(OBS) Last vertical backtrack save	{{obs_last_vertical_backtrack_path}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Obs

Live preview

Alert: obs-mediaInputPlaybackEnded

Message template: OBS media input playback ended

Overlay payload explorer

data {3}

alert: "obs-mediaInputPlaybackEnded"

extraSettings {0}

fromLumia: true

Template variable	Overlay path	Meaning	Example values
{{inputName}}	data.extraSettings.inputName	No description available yet.	No example yet
{{inputUuid}}	data.extraSettings.inputUuid	No description available yet.	No example yet

Patreon

Patreon

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Patreon

Live preview

Alert: patreon-campaignPledge

Message template: {{username}} just pledged {{currencySymbol}}{{amount}}

Example scenario

Overlay payload explorer

data {4}

alert: "patreon-campaignPledge"

extraSettings {4}

username: "lumiastream"

amount: 100

currency: "USD"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Pulse

Pulse

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Pulse

Live preview

Alert: pulse-heartrate

Message template: Heart rate changed to {{heartrate}}

Example scenario

Overlay payload explorer

data {4}

alert: "pulse-heartrate"

extraSettings {1}

heartrate: 100

fromLumia: true

dynamic {1}

value: 100

Template variable	Overlay path	Meaning	Example values
{{heartrate}}	data.extraSettings.heartrate	No description available yet.	100
{{min_heartrate}}	data.extraSettings.min_heartrate	No description available yet.	No example yet
{{max_heartrate}}	data.extraSettings.max_heartrate	No description available yet.	No example yet

Slobs

Slobs

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{slobs_current_scene}}	(SLOBS) current scene	{{slobs_current_scene}}	No example yet
{{slobs_previous_scene}}	(SLOBS) previous scene	{{slobs_previous_scene}}	No example yet
{{slobs_current_scene_collection}}	(SLOBS) current scene collection	{{slobs_current_scene_collection}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Slobs

Live preview

Alert: slobs-sceneItemHidden

Message template: SLOBS scene item {{item}} became hidden

Example scenario

Overlay payload explorer

data {4}

alert: "slobs-sceneItemHidden"

extraSettings {1}

item: "Lumia Scene"

fromLumia: true

dynamic {1}

value: "Lumia Scene"

Template variable	Overlay path	Meaning	Example values
{{item}}	data.extraSettings.item	No description available yet.	Lumia Scene

Spotify

Spotify

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{spotify_now_playing_song}}	(Spotify) the current song playing	{{spotify_now_playing_song}}	No example yet
{{spotify_now_playing_image}}	(Spotify) the url for the album art work of the current song playing	{{spotify_now_playing_image}}	https://cdn.example.com/image.png
{{spotify_now_playing_id}}	(Spotify) the id of the current song playing	{{spotify_now_playing_id}}	abc123
{{spotify_now_playing_artist}}	(Spotify) the artists of the current song playing	{{spotify_now_playing_artist}}	No example yet
{{spotify_now_playing_uri}}	(Spotify) the URI of the current song playing	{{spotify_now_playing_uri}}	No example yet
{{spotify_now_playing_url}}	(Spotify) the full URL of the current song playing	{{spotify_now_playing_url}}	https://example.com
{{spotify_now_playing_duration}}	(Spotify) the duration of the current song playing	{{spotify_now_playing_duration}}	No example yet
{{spotify_next_song}}	(Spotify) the next song in queue	{{spotify_next_song}}	No example yet
{{spotify_next_image}}	(Spotify) the url for the album art work of the next song in queue	{{spotify_next_image}}	https://cdn.example.com/image.png
{{spotify_next_artist}}	(Spotify) the artists of the next song in queue	{{spotify_next_artist}}	No example yet
{{spotify_next_id}}	(Spotify) the id of the next song in queue	{{spotify_next_id}}	abc123
{{spotify_next_url}}	(Spotify) the full URL of the next song in queue	{{spotify_next_url}}	https://example.com
{{spotify_next_uri}}	(Spotify) the URI of the next song in queue	{{spotify_next_uri}}	No example yet
{{spotify_now_playing_queue}}	(Spotify) the upcoming song queue as a JSON list	{{spotify_now_playing_queue}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Spotify

Live preview

Alert: spotify-songPaused

Message template: Song {{name}} paused

Example scenario

Overlay payload explorer

data {4}

alert: "spotify-songPaused"

extraSettings {3}

name: "Lumia Dream"

uri: "https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f"

image: "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj"

fromLumia: true

dynamic {1}

value: "Lumia Dream"

Template variable	Overlay path	Meaning	Example values
{{name}}	data.extraSettings.name	Name of user	Lumia Dreamlumiastream
{{uri}}	data.extraSettings.uri	URI	https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f
{{image}}	data.extraSettings.image	Image URL	https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj

Streamelements

Streamelements

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Streamelements

Live preview

Alert: streamelements-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "streamelements-donation"

extraSettings {5}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300
{{message}}	data.extraSettings.message	The message text sent by the user	Great Stream

Streamerbot

Streamerbot

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{streamerbot_last_action}}	(Streamerbot) Last Action that was triggered	{{streamerbot_last_action}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Streamerbot

Live preview

Alert: streamerbot-action

Message template: {{action}} action triggered

Example scenario

Overlay payload explorer

data {4}

alert: "streamerbot-action"

extraSettings {2}

action: "Lumia Action"

actionId: "lumia"

fromLumia: true

dynamic {1}

value: "Lumia Action"

Template variable	Overlay path	Meaning	Example values
{{action}}	data.extraSettings.action	Action name	Lumia Action
{{actionId}}	data.extraSettings.actionId	Action ID	lumia

Streamlabs

Streamlabs

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Streamlabs

Live preview

Alert: streamlabs-charity

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "streamlabs-charity"

extraSettings {5}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300
{{message}}	data.extraSettings.message	The message text sent by the user	Great Stream

Tiktok

Tiktok

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{tiktok_live}}	(Tiktok) Whether your Tiktok Live stream is live: {{tiktok_live}}	{{tiktok_live}}	true
{{tiktok_session_chat_count}}	(TikTok) the total chats received since Lumia Stream has turned on	{{tiktok_session_chat_count}}	42
{{tiktok_current_first_chatter}}	(Tiktok) the first user who chatted	{{tiktok_current_first_chatter}}	lumiastream
{{tiktok_current_first_chatter_count}}	(Tiktok) current first chatter count	{{tiktok_current_first_chatter_count}}	42
{{tiktok_previous_first_chatter}}	(Tiktok) previous first chatter	{{tiktok_previous_first_chatter}}	lumiastream
{{tiktok_previous_first_chatter_count}}	(Tiktok) previous first chatter count	{{tiktok_previous_first_chatter_count}}	42
{{tiktok_last_chatter}}	(TikTok) the last user who chatted	{{tiktok_last_chatter}}	lumiastream
{{tiktok_current_viewer_count}}	(Tiktok) the current views on your live video	{{tiktok_current_viewer_count}}	42
{{tiktok_total_follower_count}}	(Tiktok) total followers count	{{tiktok_total_follower_count}}	42
{{tiktok_session_follower_count}}	(Tiktok) the followers received in this session	{{tiktok_session_follower_count}}	42
{{tiktok_week_follower_count}}	(TikTok) Followers this calendar week	{{tiktok_week_follower_count}}	42
{{tiktok_month_follower_count}}	(TikTok) Followers this calendar month	{{tiktok_month_follower_count}}	42
{{tiktok_session_super_fan_count}}	(TikTok) Super Fans received this session	{{tiktok_session_super_fan_count}}	42
{{tiktok_session_share_count}}	(Tiktok) the shares received in this session	{{tiktok_session_share_count}}	42
{{tiktok_last_follower}}	(Tiktok) the last user who followed you	{{tiktok_last_follower}}	lumiastream
{{tiktok_last_super_fan}}	(TikTok) Last Super Fan	{{tiktok_last_super_fan}}	No example yet
{{tiktok_last_gifter}}	(Tiktok) the last user who sent a gift	{{tiktok_last_gifter}}	No example yet
{{tiktok_session_gifters}}	(Tiktok) Session the users who sent a gift	{{tiktok_session_gifters}}	No example yet
{{tiktok_session_gifts}}	(Tiktok) Session gift count	{{tiktok_session_gifts}}	No example yet
{{tiktok_total_gifts}}	(Tiktok) Total gift count	{{tiktok_total_gifts}}	No example yet
{{tiktok_total_likes}}	(Tiktok) total likes	{{tiktok_total_likes}}	No example yet
{{tiktok_session_likes}}	(Tiktok) the likes received in this session	{{tiktok_session_likes}}	No example yet
{{tiktok_video_count}}	(TikTok) video count	{{tiktok_video_count}}	42
{{tiktok_last_video_title}}	(Tiktok) last video title	{{tiktok_last_video_title}}	Tiktok Stream Live
{{tiktok_last_video_id}}	(Tiktok) last video id	{{tiktok_last_video_id}}	abc123
{{tiktok_last_video_link}}	(Tiktok) last video link	{{tiktok_last_video_link}}	abc123
{{tiktok_last_video_embed}}	(Tiktok) last video embeded link (used inside iframe in websites)	{{tiktok_last_video_embed}}	abc123

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Tiktok

Live preview

Alert: tiktok-battleEnd

Message template: Battle ended: {{battleLabel}} ({{result}})

Example scenario

Overlay payload explorer

data {4}

alert: "tiktok-battleEnd"

extraSettings {9}

result: "win"

battleId: "1"

battleLabel: "lumiastream vs rivalstream"

creatorUsername: "lumiastream"

opponentUsername: "rivalstream"

creatorScore: 1200

opponentScore: 900

winnerUsername: "lumiastream"

loserUsername: "rivalstream"

fromLumia: true

dynamic {1}

value: "win"

Template variable	Overlay path	Meaning	Example values
{{battleId}}	data.extraSettings.battleId	TikTok battle ID	1
{{battleLabel}}	data.extraSettings.battleLabel	TikTok battle label, usually creator vs opponent	lumiastream vs rivalstream
{{creatorUsername}}	data.extraSettings.creatorUsername	TikTok battle creator username	lumiastream
{{opponentUsername}}	data.extraSettings.opponentUsername	TikTok battle opponent username	rivalstream
{{creatorScore}}	data.extraSettings.creatorScore	TikTok battle creator score	1200
{{opponentScore}}	data.extraSettings.opponentScore	TikTok battle opponent score	900
{{result}}	data.extraSettings.result	No description available yet.	win
{{winnerUsername}}	data.extraSettings.winnerUsername	No description available yet.	lumiastream
{{loserUsername}}	data.extraSettings.loserUsername	No description available yet.	rivalstream

Tiltify

Tiltify

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{tiltify_goal_amount}}	Tiltify campaign goal amount	{{tiltify_goal_amount}}	25.00
{{tiltify_total_raised}}	Total amount raised for the Tiltify campaign	{{tiltify_total_raised}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Tiltify

Live preview

Alert: tiltify-campaignDonation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}. They said {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "tiltify-campaignDonation"

extraSettings {5}

username: "lumiastream"

amount: 100

currency: "USD"

message: "Great Stream"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Throne

Throne

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{throne_last_gift}}	(Throne) latest gift details	{{throne_last_gift}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Throne

Live preview

Alert: throne-contributionPurchase

Message template: {{username}} contributed {{amount}} {{currency}} toward {{itemName}} on Throne. {{message}}

Example scenario

Overlay payload explorer

data {4}

alert: "throne-contributionPurchase"

extraSettings {8}

username: "lumiastream"

itemName: "AirPods Max"

amount: 10

currency: "USD"

message: "Happy to contribute!"

displayname: "lumiastream"

itemThumbnailUrl: "https://m.media-amazon.com/images/I/81jqUPkIVRL._AC_SX522_.jpg"

creatorUsername: "lumiastream"

fromLumia: true

dynamic {2}

value: 10

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{displayname}}	data.extraSettings.displayname	The display name of the sender	lumiastream
{{message}}	data.extraSettings.message	The message text sent by the user	Happy to contribute!
{{itemName}}	data.extraSettings.itemName	No description available yet.	AirPods Max
{{itemThumbnailUrl}}	data.extraSettings.itemThumbnailUrl	No description available yet.	https://m.media-amazon.com/images/I/81jqUPkIVRL._AC_SX522_.jpg
{{amount}}	data.extraSettings.amount	The amount sent	10
{{currency}}	data.extraSettings.currency	The currency used	USD
{{creatorUsername}}	data.extraSettings.creatorUsername	TikTok battle creator username	lumiastream
{{raw}}	data.extraSettings.raw	The raw data that comes in through the platform for the alert. This is useful for custom code when data is needed that we don't provide by default.	No example yet

Tipeeestream

Tipeeestream

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Tipeeestream

Live preview

Alert: tipeeestream-donation

Message template: {{username}} just tipped {{currencySymbol}}{{amount}}

Example scenario

Overlay payload explorer

data {4}

alert: "tipeeestream-donation"

extraSettings {4}

username: "lumiastream"

amount: 100

currency: "USD"

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{currency}}	data.extraSettings.currency	The currency used	USD
{{currencySymbol}}	data.extraSettings.currencySymbol	The currency symbol used	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	100200300

Treatstream

Treatstream

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Treatstream

Live preview

Alert: treatstream-treat

Message template: {{username}} sent {{treat}}

Example scenario

Overlay payload explorer

data {4}

alert: "treatstream-treat"

extraSettings {2}

treats: "Lumia Treats"

treat: "Lumia Treats"

fromLumia: true

dynamic {1}

value: "Lumia Treats"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	No example yet
{{treat}}	data.extraSettings.treat	Treat sent	Lumia Treats

Twitch

Twitch

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{twitch_uptime}}	(Twitch) The time your Twitch Live stream has been started for: {{twitch_uptime}}	{{twitch_uptime}}	2h 14m
{{twitch_live}}	(Twitch) Whether your Twitch Live stream is live: {{twitch_live}}	{{twitch_live}}	true
{{twitch_followage={{message}}}}	No description available yet.	{{twitch_followage={{message}}}}	2 years, 3 months
{{twitch_next_ad}}	(Twitch) Gets the remaining time for how long until the next ad	{{twitch_next_ad}}	No example yet
{{twitch_get_avatar={{message}}}}	No description available yet.	{{twitch_get_avatar={{message}}}}	https://cdn.example.com/image.png
{{twitch_followage}}	(Twitch) The time a user has been following your channel: {{twitch_followage={{message}}}	{{twitch_followage}}	2 years, 3 months
{{twitch_get_avatar}}	(Twitch) Gets the avatar based on a username: {{twitch_get_avatar={{message}}}	{{twitch_get_avatar}}	https://cdn.example.com/image.png
{{twitch_user_id}}	(Twitch) user id of your channel	{{twitch_user_id}}	abc123
{{twitch_username}}	(Twitch) username of your channel	{{twitch_username}}	lumiastream
{{twitch_current_viewer_count}}	(Twitch) the current viewer count that is watching	{{twitch_current_viewer_count}}	42
{{twitch_current_viewers}}	(Twitch) comma separated list of current viewers	{{twitch_current_viewers}}	lumiastream,rgblumia
{{twitch_total_follower_count}}	(Twitch) the total follower count of your Twitch channel	{{twitch_total_follower_count}}	42
{{twitch_current_followers}}	(Twitch) comma separated list of current followers	{{twitch_current_followers}}	lumiastream
{{twitch_session_follower_count}}	(Twitch) the total followers received since Lumia Stream has turned on	{{twitch_session_follower_count}}	42
{{twitch_week_follower_count}}	(Twitch) Followers this calendar week	{{twitch_week_follower_count}}	42
{{twitch_month_follower_count}}	(Twitch) Followers this calendar month	{{twitch_month_follower_count}}	42
{{twitch_current_subscribers}}	(Twitch) comma separated list of current subscribers	{{twitch_current_subscribers}}	lumiastream,rgblumia
{{twitch_total_subscriber_count}}	(Twitch) the total subscriber count of your Twitch channel	{{twitch_total_subscriber_count}}	42
{{twitch_session_subscribers_count}}	(Twitch) the total subscribers received since Lumia Stream has turned on	{{twitch_session_subscribers_count}}	42
{{twitch_session_new_subscribers_count}}	(Twitch) New subscribers received this session	{{twitch_session_new_subscribers_count}}	42
{{twitch_session_resub_subscribers_count}}	(Twitch) Resubscribers received this session	{{twitch_session_resub_subscribers_count}}	42
{{twitch_session_gifted_subscribers_count}}	(Twitch) Gifted subscribers received this session	{{twitch_session_gifted_subscribers_count}}	42
{{twitch_week_subscriber_count}}	(Twitch) Subscribers this calendar week	{{twitch_week_subscriber_count}}	42
{{twitch_month_subscriber_count}}	(Twitch) Subscribers this calendar month	{{twitch_month_subscriber_count}}	42
{{twitch_session_gifts_count}}	(Twitch) the total gifts received since Lumia Stream has turned on	{{twitch_session_gifts_count}}	42
{{twitch_total_gift_subscription_count}}	(Twitch) the total gift subscription count of your Twitch channel	{{twitch_total_gift_subscription_count}}	42
{{twitch_alltime_top_gifter}}	(Twitch) All-time top gifter	{{twitch_alltime_top_gifter}}	No example yet
{{twitch_alltime_top_gifter_amount}}	No description available yet.	{{twitch_alltime_top_gifter_amount}}	25.00
{{twitch_current_mods}}	(Twitch) comma separated list of current mods	{{twitch_current_mods}}	No example yet
{{twitch_last_follower}}	(Twitch) the last user who followed	{{twitch_last_follower}}	lumiastream
{{twitch_session_follower}}	(Twitch) Session follower list	{{twitch_session_follower}}	lumiastream
{{twitch_last_subscriber}}	(Twitch) the last user who subscribed	{{twitch_last_subscriber}}	lumiastream
{{twitch_last_new_subscriber}}	(Twitch) Last new subscriber	{{twitch_last_new_subscriber}}	lumiastream
{{twitch_last_resubscriber}}	(Twitch) Last resubscriber	{{twitch_last_resubscriber}}	lumiastream
{{twitch_last_gifter}}	(Twitch) Last user who sent a gift subscription	{{twitch_last_gifter}}	No example yet
{{twitch_last_gifter_amount}}	No description available yet.	{{twitch_last_gifter_amount}}	25.00
{{twitch_last_gifted}}	(Twitch) Last gifted subscription recipient	{{twitch_last_gifted}}	No example yet
{{twitch_session_subscribers}}	(Twitch) Session subscribers list	{{twitch_session_subscribers}}	lumiastream,rgblumia
{{twitch_session_chat_count}}	(Twitch) the total chats received since Lumia Stream has turned on	{{twitch_session_chat_count}}	42
{{twitch_current_first_chatter}}	(Twitch) the first user who chatted	{{twitch_current_first_chatter}}	lumiastream
{{twitch_current_first_chatter_count}}	(Twitch) current first chatter count	{{twitch_current_first_chatter_count}}	42
{{twitch_previous_first_chatter}}	(Twitch) previous first chatter	{{twitch_previous_first_chatter}}	lumiastream
{{twitch_previous_first_chatter_count}}	(Twitch) previous first chatter count	{{twitch_previous_first_chatter_count}}	42
{{twitch_last_chatter}}	(Twitch) the last user who chatted	{{twitch_last_chatter}}	lumiastream
{{twitch_last_raider}}	(Twitch) the last user who raided	{{twitch_last_raider}}	lumiastream
{{twitch_last_raid_amount}}	(Twitch) the amount of viewers for the last raider	{{twitch_last_raid_amount}}	25.00
{{twitch_session_raiders}}	(Twitch) Session raider list	{{twitch_session_raiders}}	lumiastream
{{twitch_total_bits_count}}	(Twitch) the total bits count of your Twitch channel	{{twitch_total_bits_count}}	42
{{twitch_session_bits_count}}	(Twitch) the total bits received since Lumia Stream has turned on	{{twitch_session_bits_count}}	42
{{twitch_week_bits_count}}	(Twitch) Bits received this calendar week	{{twitch_week_bits_count}}	42
{{twitch_month_bits_count}}	(Twitch) Bits received this calendar month	{{twitch_month_bits_count}}	42
{{twitch_last_bit}}	(Twitch) the last user who sent bits	{{twitch_last_bit}}	No example yet
{{twitch_last_bit_amount}}	(Twitch) the amount of bits for the last person to send bits	{{twitch_last_bit_amount}}	25.00
{{twitch_session_bits}}	(Twitch) Session cheer list	{{twitch_session_bits}}	No example yet
{{twitch_session_bits_with_amount}}	(Twitch) Session cheer list with amount	{{twitch_session_bits_with_amount}}	25.00
{{twitch_session_top_cheer}}	(Twitch) Largest single cheer this session	{{twitch_session_top_cheer}}	No example yet
{{twitch_session_top_cheer_amount}}	No description available yet.	{{twitch_session_top_cheer_amount}}	25.00
{{twitch_session_top_cheerer}}	(Twitch) Top cheerer this session	{{twitch_session_top_cheerer}}	No example yet
{{twitch_session_top_cheerer_amount}}	No description available yet.	{{twitch_session_top_cheerer_amount}}	25.00
{{twitch_week_top_cheerer}}	(Twitch) Top cheerer this week	{{twitch_week_top_cheerer}}	No example yet
{{twitch_week_top_cheerer_amount}}	No description available yet.	{{twitch_week_top_cheerer_amount}}	25.00
{{twitch_month_top_cheerer}}	(Twitch) Top cheerer this month	{{twitch_month_top_cheerer}}	No example yet
{{twitch_month_top_cheerer_amount}}	No description available yet.	{{twitch_month_top_cheerer_amount}}	25.00
{{twitch_hypetrain_active}}	(Twitch) Whether Hype Train is active	{{twitch_hypetrain_active}}	No example yet
{{twitch_hypetrain_level}}	(Twitch) Hype Train level	{{twitch_hypetrain_level}}	No example yet
{{twitch_hypetrain_progress}}	(Twitch) Hype Train progress	{{twitch_hypetrain_progress}}	No example yet
{{twitch_hypetrain_level_goal}}	(Twitch) Hype Train level goal	{{twitch_hypetrain_level_goal}}	No example yet
{{twitch_hypetrain_total}}	(Twitch) Hype Train total	{{twitch_hypetrain_total}}	No example yet
{{twitch_hypetrain_top_contributor}}	(Twitch) Hype Train top contributor	{{twitch_hypetrain_top_contributor}}	No example yet
{{twitch_hypetrain_top_contributor_amount}}	No description available yet.	{{twitch_hypetrain_top_contributor_amount}}	25.00
{{twitch_alltime_top_cheerer}}	(Twitch) All-time top cheerer	{{twitch_alltime_top_cheerer}}	No example yet
{{twitch_alltime_top_cheerer_amount}}	No description available yet.	{{twitch_alltime_top_cheerer_amount}}	25.00
{{twitch_week_top_cheer}}	(Twitch) Largest single cheer this week	{{twitch_week_top_cheer}}	No example yet
{{twitch_week_top_cheer_amount}}	Bit amount for the largest single Twitch week cheer	{{twitch_week_top_cheer_amount}}	25.00
{{twitch_month_top_cheer}}	(Twitch) Largest single cheer this month	{{twitch_month_top_cheer}}	No example yet
{{twitch_month_top_cheer_amount}}	Bit amount for the largest single Twitch month cheer	{{twitch_month_top_cheer_amount}}	25.00
{{twitch_alltime_top_cheer}}	(Twitch) Largest single cheer all-time	{{twitch_alltime_top_cheer}}	No example yet
{{twitch_alltime_top_cheer_amount}}	Bit amount for the largest single all-time Twitch cheer	{{twitch_alltime_top_cheer_amount}}	25.00
{{twitch_last_channel_points_redeemer}}	(Twitch) Most recent channel-points redeemer name	{{twitch_last_channel_points_redeemer}}	No example yet
{{twitch_last_channel_points_amount}}	(Twitch) Cost in channel points of the most recent redemption	{{twitch_last_channel_points_amount}}	25.00
{{top_cheerer_list}}	Top cheerers list	{{top_cheerer_list}}	lumiastream,rgblumia
{{top_cheerer_list_amount}}	Amounts for the top cheerers list	{{top_cheerer_list_amount}}	25.00
{{week_top_cheerer_list}}	Top cheerers this week list	{{week_top_cheerer_list}}	lumiastream,rgblumia
{{week_top_cheerer_list_amount}}	Amounts for the top cheerers this week list	{{week_top_cheerer_list_amount}}	25.00
{{month_top_cheerer_list}}	Top cheerers this month list	{{month_top_cheerer_list}}	lumiastream,rgblumia
{{month_top_cheerer_list_amount}}	Amounts for the top cheerers this month list	{{month_top_cheerer_list_amount}}	25.00
{{top_gifter_list}}	Top gifters list	{{top_gifter_list}}	lumiastream,rgblumia
{{top_gifter_list_amount}}	Amounts for the top gifters list	{{top_gifter_list_amount}}	25.00
{{week_top_gifter_list}}	Top gifters this week list	{{week_top_gifter_list}}	lumiastream,rgblumia
{{week_top_gifter_list_amount}}	Amounts for the top gifters this week list	{{week_top_gifter_list_amount}}	25.00
{{month_top_gifter_list}}	Top gifters this month list	{{month_top_gifter_list}}	lumiastream,rgblumia
{{month_top_gifter_list_amount}}	Amounts for the top gifters this month list	{{month_top_gifter_list_amount}}	25.00
{{twitch_last_clip_id}}	(Twitch) the last clip id that was made from Lumia	{{twitch_last_clip_id}}	abc123
{{twitch_last_clip_url}}	(Twitch) the last clip url that was made from Lumia	{{twitch_last_clip_url}}	https://example.com
{{twitch_last_clip_thumbnail_url}}	(Twitch) Last clip thumbnail URL	{{twitch_last_clip_thumbnail_url}}	https://cdn.example.com/image.png
{{twitch_channel_title}}	(Twitch) the title of your channel	{{twitch_channel_title}}	Twitch Stream Live
{{twitch_channel_description}}	(Twitch) the description of your channel	{{twitch_channel_description}}	Going live with alerts and lights
{{twitch_avatar}}	(Twitch) avatar of your channel	{{twitch_avatar}}	https://cdn.example.com/image.png
{{twitch_offline_image}}	(Twitch) offline image of your channel	{{twitch_offline_image}}	https://cdn.example.com/image.png
{{twitch_category}}	(Twitch) the current category of your channel	{{twitch_category}}	Just Chatting
{{twitch_category_id}}	(Twitch) the current category id of your channel	{{twitch_category_id}}	Just Chatting
{{twitch_current_poll_id}}	(Twitch) the poll id that was last ran	{{twitch_current_poll_id}}	abc123
{{twitch_current_prediction_id}}	(Twitch) the prediction id that was last ran	{{twitch_current_prediction_id}}	abc123

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Twitch

Live preview

Alert: twitch-adStarted

Message template: ad started

Example scenario

Overlay payload explorer

data {4}

alert: "twitch-adStarted"

extraSettings {4}

length: "60"

amount: 60

is_automatic: false

started_at: "2022-07-26T17:00:03.17106713Z"

fromLumia: true

dynamic {2}

value: "60"

amount: 60

Template variable	Overlay path	Meaning	Example values
{{length}}	data.extraSettings.length	Length of time in seconds	60
{{is_automatic}}	data.extraSettings.is_automatic	Whether the ad is playing automatically or not	false
{{started_at}}	data.extraSettings.started_at	ISO String of the time this alert was triggered	2022-07-26T17:00:03.17106713Z
{{twitch_next_ad}}	data.extraSettings.twitch_next_ad	(Twitch) Gets the remaining time for how long until the next ad	No example yet
{{amount}}	data.extraSettings.amount	The amount sent	60

Twitter

Twitter

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{twitter_last_tweet}}	(Twitter) the last tweet sent from your Twitter	{{twitter_last_tweet}}	No example yet
{{twitter_last_tweet_id}}	(Twitter) the last tweet ID sent from your Twitter	{{twitter_last_tweet_id}}	abc123
{{twitter_last_tweet_link}}	(Twitter) the link for the last tweet sent from your Twitter	{{twitter_last_tweet_link}}	No example yet
{{twitter_likes_count}}	(Twitter) the total likes count of your last tweet	{{twitter_likes_count}}	42
{{twitter_retweets_count}}	(Twitter) the total retweet count of your last tweet	{{twitter_retweets_count}}	42
{{twitter_last_follower_username}}	(Twitter) the last follower's username	{{twitter_last_follower_username}}	lumiastream
{{twitter_last_follower_id}}	(Twitter) the last follower's user id	{{twitter_last_follower_id}}	lumiastream
{{twitter_last_follower_avatar}}	(Twitter) the last follower's avatar	{{twitter_last_follower_avatar}}	https://cdn.example.com/image.png
{{twitter_last_follower_tweet}}	(Twitter) the last follower's tweet	{{twitter_last_follower_tweet}}	lumiastream
{{twitter_last_follower_tweet_url}}	(Twitter) the last follower's tweet url	{{twitter_last_follower_tweet_url}}	https://example.com
{{twitter_last_follower_background_color}}	(Twitter) the last follower's background color	{{twitter_last_follower_background_color}}	lumiastream
{{twitter_last_follower_link_color}}	(Twitter) the last follower's link color	{{twitter_last_follower_link_color}}	lumiastream
{{twitter_follower_count}}	(Twitter) the current count of users following you	{{twitter_follower_count}}	42
{{twitter_following_count}}	(Twitter) the current count of users you are following	{{twitter_following_count}}	42
{{twitter_tweets_count}}	(Twitter) the total count of tweets you've made	{{twitter_tweets_count}}	42
{{twitter_last_tweet_likes_count}}	(Twitter) the total likes count of your last tweet	{{twitter_last_tweet_likes_count}}	42
{{twitter_last_tweet_retweets_count}}	(Twitter) the total retweets count of your last tweet	{{twitter_last_tweet_retweets_count}}	42
{{twitter_last_retweeter_username}}	(Twitter) the last retweeter's username	{{twitter_last_retweeter_username}}	lumiastream
{{twitter_last_retweeter_id}}	(Twitter) the last retweeter's id	{{twitter_last_retweeter_id}}	abc123
{{twitter_last_retweeter_avatar}}	(Twitter) the last retweeter's avatar	{{twitter_last_retweeter_avatar}}	https://cdn.example.com/image.png
{{twitter_last_retweeter_tweet}}	(Twitter) the last retweeter's tweet	{{twitter_last_retweeter_tweet}}	No example yet
{{twitter_last_retweeter_background_color}}	(Twitter) the last retweeter's background color	{{twitter_last_retweeter_background_color}}	#FF4076
{{twitter_last_retweeter_link_color}}	(Twitter) the last retweeter's link color	{{twitter_last_retweeter_link_color}}	#FF4076

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Twitter

Live preview

Alert: twitter-follower

Message template: {{username}} just followed

Example scenario

Overlay payload explorer

data {4}

alert: "twitter-follower"

extraSettings {3}

username: "lumiastream"

followers: 100

avatar: "https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png"

fromLumia: true

dynamic {1}

value: "lumiastream"

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	lumiastream
{{userId}}	data.extraSettings.userId	The user ID of the sender	No example yet
{{displayname}}	data.extraSettings.displayname	The display name of the sender	No example yet
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message	https://static-cdn.jtvnw.net/jtv_user_pictures/2b1fa336-f9b2-42cf-bd2c-98675da74982-profile_image-70x70.png
{{followers}}	data.extraSettings.followers	Followers count	100

Vlc

Vlc

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{vlc_now_playing_media}}	(VLC) the current media playing on VLC	{{vlc_now_playing_media}}	No example yet
{{vlc_now_playing_image}}	(VLC) the url for the image of the current media playing on VLC	{{vlc_now_playing_image}}	https://cdn.example.com/image.png
{{vlc_now_playing_id}}	(VLC) the id of the current media playing on VLC	{{vlc_now_playing_id}}	abc123
{{vlc_now_playing_artist}}	(VLC) the artists of the current media playing on VLC	{{vlc_now_playing_artist}}	No example yet
{{vlc_now_playing_uri}}	(VLC) the URI of the current media playing on VLC	{{vlc_now_playing_uri}}	No example yet
{{vlc_now_playing_url}}	(VLC) the full URL of the current media playing on VLC	{{vlc_now_playing_url}}	https://example.com
{{vlc_now_playing_duration}}	No description available yet.	{{vlc_now_playing_duration}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Vlc

Live preview

Alert: vlc-songPaused

Message template: Song {{name}} paused

Example scenario

Overlay payload explorer

data {4}

alert: "vlc-songPaused"

extraSettings {3}

name: "Lumia Dream"

uri: "https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f"

image: "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj"

fromLumia: true

dynamic {1}

value: "Lumia Dream"

Template variable	Overlay path	Meaning	Example values
{{name}}	data.extraSettings.name	Name of user	Lumia Dreamlumiastream
{{uri}}	data.extraSettings.uri	URI	https://open.spotify.com/track/3vBn6l5T2AWm4NlqNWE43f
{{image}}	data.extraSettings.image	Image URL	https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj

Voicemod

Voicemod

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{voicemod_voice_changer_on}}	(Voicemod) voice chaner on	{{voicemod_voice_changer_on}}	No example yet
{{voicemod_previous_voice}}	(Voicemod) previous voice	{{voicemod_previous_voice}}	No example yet
{{voicemod_current_voice}}	(Voicemod) current voice	{{voicemod_current_voice}}	No example yet

Vtubestudio

Vtubestudio

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{vtubestudio_current_model}}	(VTube Studio) Current model	{{vtubestudio_current_model}}	No example yet
{{vtubestudio_current_background}}	(VTube Studio) Current background	{{vtubestudio_current_background}}	No example yet
{{vtubestudio_last_hotkey_triggered}}	(VTube Studio) Last hotkey triggered	{{vtubestudio_last_hotkey_triggered}}	C#m

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Vtubestudio

Live preview

Alert: vtubestudio-animationEnd

Message template: {{name}} animation ended

Example scenario

Overlay payload explorer

data {4}

alert: "vtubestudio-animationEnd"

extraSettings {5}

name: "Go Bright"

modelName: "Light Bulb"

modelId: "123"

animationName: "Go Bright"

animationLength: 40.3

fromLumia: true

dynamic {1}

value: "Go Bright"

Template variable	Overlay path	Meaning	Example values
{{name}}	data.extraSettings.name	Name of user	Go BrightAnimation
{{modelName}}	data.extraSettings.modelName	No description available yet.	Light Bulb
{{modelId}}	data.extraSettings.modelId	No description available yet.	123
{{animationName}}	data.extraSettings.animationName	No description available yet.	Go Bright
{{animationLength}}	data.extraSettings.animationLength	No description available yet.	40.3

Woocommerce

Woocommerce

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{woocommerce_last_order_name}}	(Woocommerce) the last person who ordered an item's full name	{{woocommerce_last_order_name}}	No example yet
{{woocommerce_last_order_first_name}}	(Woocommerce) the last person who ordered an item's first name	{{woocommerce_last_order_first_name}}	No example yet
{{woocommerce_last_order_last_name}}	(Woocommerce) the last person who ordered an item's last name	{{woocommerce_last_order_last_name}}	No example yet
{{woocommerce_last_order_items}}	(Woocommerce) the last items that were ordered	{{woocommerce_last_order_items}}	No example yet
{{woocommerce_last_order_item}}	(Woocommerce) the last item that was ordered. Will only get the first item in the last order	{{woocommerce_last_order_item}}	No example yet
{{woocommerce_last_order_amount}}	(Woocommerce) the amount for the last order that was made	{{woocommerce_last_order_amount}}	25.00
{{woocommerce_last_order_amount_currency}}	(Woocommerce) the currency of the amount for the last order that was made	{{woocommerce_last_order_amount_currency}}	USD

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Woocommerce

Live preview

Alert: woocommerce-order

Message template: Someone just ordered {{item}} in the amount of {{amount}}

Example scenario

Overlay payload explorer

data {4}

alert: "woocommerce-order"

extraSettings {4}

username: "lumiastream"

item: "rgb light"

amount: 100

currency: "USD"

fromLumia: true

dynamic {2}

value: 100

currency: "USD"

No fields available for Woocommerce-Order.

Youtube

Youtube

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{youtube_uptime}}	(YouTube) The time your YouTube Live stream has been started for: {{youtube_uptime}}	{{youtube_uptime}}	2h 14m
{{youtube_live}}	(YouTube) Whether your YouTube Live stream is live: {{youtube_live}}	{{youtube_live}}	true
{{youtube_session_chat_count}}	(Youtube) the total chats received since Lumia Stream has turned on	{{youtube_session_chat_count}}	42
{{youtube_current_first_chatter}}	(Youtube) the first user who chatted	{{youtube_current_first_chatter}}	lumiastream
{{youtube_current_first_chatter_count}}	(Youtube) current first chatter count	{{youtube_current_first_chatter_count}}	42
{{youtube_previous_first_chatter}}	(Youtube) previous first chatter	{{youtube_previous_first_chatter}}	lumiastream
{{youtube_previous_first_chatter_count}}	(Youtube) previous first chatter count	{{youtube_previous_first_chatter_count}}	42
{{youtube_last_chatter}}	(Youtube) the last user who chatted	{{youtube_last_chatter}}	lumiastream
{{youtube_session_subscriber_count}}	(Youtube) the total subscribers received since Lumia Stream has turned on	{{youtube_session_subscriber_count}}	42
{{youtube_week_subscriber_count}}	(YouTube) Subscribers this calendar week	{{youtube_week_subscriber_count}}	42
{{youtube_month_subscriber_count}}	(YouTube) Subscribers this calendar month	{{youtube_month_subscriber_count}}	42
{{youtube_total_subscriber_count}}	(Youtube) the total subscriber count of your youtube channel	{{youtube_total_subscriber_count}}	42
{{youtube_session_superchat_count}}	(Youtube) the total super chats received since Lumia Stream has turned on	{{youtube_session_superchat_count}}	42
{{youtube_session_superchat_amount}}	(YouTube) Running superchat amount this session	{{youtube_session_superchat_amount}}	25.00
{{youtube_week_superchat_amount}}	(YouTube) Running superchat amount this week	{{youtube_week_superchat_amount}}	25.00
{{youtube_month_superchat_amount}}	(YouTube) Running superchat amount this month	{{youtube_month_superchat_amount}}	25.00
{{youtube_total_superchat_amount}}	(YouTube) Running superchat amount all-time	{{youtube_total_superchat_amount}}	25.00
{{youtube_session_top_superchat}}	(YouTube) Largest single superchat this session	{{youtube_session_top_superchat}}	No example yet
{{youtube_session_top_superchat_amount}}	Amount for the largest single session superchat	{{youtube_session_top_superchat_amount}}	25.00
{{youtube_week_top_superchat}}	(YouTube) Largest single superchat this week	{{youtube_week_top_superchat}}	No example yet
{{youtube_week_top_superchat_amount}}	Amount for the largest single week superchat	{{youtube_week_top_superchat_amount}}	25.00
{{youtube_month_top_superchat}}	(YouTube) Largest single superchat this month	{{youtube_month_top_superchat}}	No example yet
{{youtube_month_top_superchat_amount}}	Amount for the largest single month superchat	{{youtube_month_top_superchat_amount}}	25.00
{{youtube_alltime_top_superchat}}	(YouTube) Largest single superchat all-time	{{youtube_alltime_top_superchat}}	No example yet
{{youtube_alltime_top_superchat_amount}}	Amount for the largest single all-time superchat	{{youtube_alltime_top_superchat_amount}}	25.00
{{youtube_session_top_superchatter}}	(YouTube) Top superchatter this session (cumulative giver)	{{youtube_session_top_superchatter}}	lumiastream
{{youtube_session_top_superchatter_amount}}	Amount donated by the session top superchatter	{{youtube_session_top_superchatter_amount}}	25.00
{{youtube_week_top_superchatter}}	(YouTube) Top superchatter this week (cumulative giver)	{{youtube_week_top_superchatter}}	lumiastream
{{youtube_week_top_superchatter_amount}}	Amount donated by the week top superchatter	{{youtube_week_top_superchatter_amount}}	25.00
{{youtube_month_top_superchatter}}	(YouTube) Top superchatter this month (cumulative giver)	{{youtube_month_top_superchatter}}	lumiastream
{{youtube_month_top_superchatter_amount}}	Amount donated by the month top superchatter	{{youtube_month_top_superchatter_amount}}	25.00
{{youtube_alltime_top_superchatter}}	(YouTube) All-time top superchatter (cumulative giver)	{{youtube_alltime_top_superchatter}}	lumiastream
{{youtube_alltime_top_superchatter_amount}}	Amount donated by the all-time top superchatter	{{youtube_alltime_top_superchatter_amount}}	25.00
{{youtube_last_superchatter}}	(Youtube) the last user who super chatted	{{youtube_last_superchatter}}	lumiastream
{{youtube_session_superchatters}}	(Youtube) Session super chatters	{{youtube_session_superchatters}}	lumiastream
{{youtube_session_supersticker_count}}	(Youtube) the total super stickers received since Lumia Stream has turned on	{{youtube_session_supersticker_count}}	42
{{youtube_last_supersticker}}	(Youtube) the last user who sent a super sticker	{{youtube_last_supersticker}}	No example yet
{{youtube_session_superstickers}}	(Youtube) Session super stickers	{{youtube_session_superstickers}}	No example yet
{{youtube_total_member_count}}	(Youtube) the total member count	{{youtube_total_member_count}}	42
{{youtube_session_member_count}}	(Youtube) the total members received since Lumia Stream has turned on	{{youtube_session_member_count}}	42
{{youtube_week_member_count}}	(YouTube) Members this calendar week	{{youtube_week_member_count}}	42
{{youtube_month_member_count}}	(YouTube) Members this calendar month	{{youtube_month_member_count}}	42
{{youtube_last_member}}	(Youtube) the last user who became a member	{{youtube_last_member}}	lumiastream
{{youtube_session_members}}	(Youtube) Session members	{{youtube_session_members}}	lumiastream,rgblumia
{{youtube_last_subscriber}}	(Youtube) the last user who subscribed	{{youtube_last_subscriber}}	lumiastream
{{youtube_total_gift_members_count}}	(Youtube) the total gift members count of your Youtube channel	{{youtube_total_gift_members_count}}	42
{{youtube_session_gift_members_count}}	(Youtube) the total gift members received since Lumia Stream has turned on	{{youtube_session_gift_members_count}}	42
{{youtube_last_gift_member}}	(Youtube) the last user who sent a gift	{{youtube_last_gift_member}}	lumiastream
{{youtube_session_gift_members}}	(Youtube) Session gift members list	{{youtube_session_gift_members}}	lumiastream,rgblumia
{{youtube_total_jewels_count}}	(YouTube) total Jewels received all time	{{youtube_total_jewels_count}}	42
{{youtube_session_jewels_count}}	(YouTube) total Jewels received this session	{{youtube_session_jewels_count}}	42
{{youtube_last_jewels}}	(YouTube) the amount of Jewels from the last Jewels event	{{youtube_last_jewels}}	No example yet
{{youtube_last_jewels_user}}	(YouTube) the last user who sent Jewels	{{youtube_last_jewels_user}}	No example yet
{{youtube_session_jewels_gifters}}	(YouTube) session Jewel gifters list	{{youtube_session_jewels_gifters}}	No example yet
{{youtube_total_video_count}}	(Youtube) the total videos uploaded on your channel	{{youtube_total_video_count}}	42
{{youtube_total_view_count}}	(YouTube) total view count of your channel	{{youtube_total_view_count}}	42

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Youtube

Live preview

Alert: youtube-entrance

Message template: Welcome {{username}}

Overlay payload explorer

data {3}

alert: "youtube-entrance"

extraSettings {0}

fromLumia: true

Template variable	Overlay path	Meaning	Example values
{{username}}	data.extraSettings.username	The username of the sender	No example yet
{{displayname}}	data.extraSettings.displayname	The display name of the sender	No example yet
{{userId}}	data.extraSettings.userId	The user ID of the sender	No example yet
{{avatar}}	data.extraSettings.avatar	The url of the avatar of the sender for a message	No example yet
{{message}}	data.extraSettings.message	The message text sent by the user	No example yet

Youtubemusic

Youtubemusic

Variables only work when the event provides that data. Global variables are broadly available. Chat and alert variables only work in those specific contexts.

Search variables on this platform

Available everywhere

These are the safest variables to use across the selected platform. This table includes sample output values.

Variable	Meaning	Use it like	Example values
{{youtubemusic_now_playing_song}}	(Youtube Music) the current song playing	{{youtubemusic_now_playing_song}}	No example yet
{{youtubemusic_now_playing_image}}	(Youtube Music) the url for the album art work of the current song playing	{{youtubemusic_now_playing_image}}	https://cdn.example.com/image.png
{{youtubemusic_now_playing_id}}	(Youtube Music) the id of the current song playing	{{youtubemusic_now_playing_id}}	abc123
{{youtubemusic_now_playing_artist}}	(Youtube Music) the artists of the current song playing	{{youtubemusic_now_playing_artist}}	No example yet
{{youtubemusic_now_playing_url}}	(Youtube Music) the full URL of the current song playing	{{youtubemusic_now_playing_url}}	https://example.com
{{youtubemusic_now_playing_duration}}	No description available yet.	{{youtubemusic_now_playing_duration}}	No example yet
{{youtubemusic_next_song}}	(Youtube Music) the next song in queue	{{youtubemusic_next_song}}	No example yet
{{youtubemusic_next_image}}	(Youtube Music) the url for the album art work of the next song in queue	{{youtubemusic_next_image}}	https://cdn.example.com/image.png
{{youtubemusic_next_artist}}	(Youtube Music) the artists of the next song in queue	{{youtubemusic_next_artist}}	No example yet
{{youtubemusic_next_id}}	(Youtube Music) the id of the next song in queue	{{youtubemusic_next_id}}	abc123
{{youtubemusic_next_url}}	(Youtube Music) the full URL of the next song in queue	{{youtubemusic_next_url}}	https://example.com
{{youtubemusic_queue}}	(Youtube Music) the current queue separated by commas	{{youtubemusic_queue}}	No example yet

Alerts and events

Search an alert and inspect a live example of what Overlay.on('alert') receives. Template alert variables map to the same keys inside data.extraSettings. For the full alert event type, see Overlay Type Definitions.

Search alerts on Youtubemusic

Live preview

Alert: youtubemusic-songPaused

Message template: Song {{name}} paused

Example scenario

Overlay payload explorer

data {4}

alert: "youtubemusic-songPaused"

extraSettings {3}

name: "Lumia Dream"

url: "https://music.youtube.com/watch?v=M8xO9hyYC4U"

image: "https://lh3.googleusercontent.com/hxcNF4a-5MZqN9HmIyPMlVm6AzQ6CI0MmisFqZTglun4VJ2Ghli4lvyQpJS2oeqjnT8a0S2EAWklTo14=w544-h544-l90-rj"

fromLumia: true

dynamic {1}

value: "Lumia Dream"

Template variable	Overlay path	Meaning	Example values
{{youtubemusic_now_playing_song}}	data.extraSettings.youtubemusic_now_playing_song	(Youtube Music) the current song playing	No example yet
{{youtubemusic_now_playing_image}}	data.extraSettings.youtubemusic_now_playing_image	(Youtube Music) the url for the album art work of the current song playing	No example yet
{{youtubemusic_now_playing_id}}	data.extraSettings.youtubemusic_now_playing_id	(Youtube Music) the id of the current song playing	No example yet
{{youtubemusic_now_playing_artist}}	data.extraSettings.youtubemusic_now_playing_artist	(Youtube Music) the artists of the current song playing	No example yet
{{youtubemusic_now_playing_url}}	data.extraSettings.youtubemusic_now_playing_url	(Youtube Music) the full URL of the current song playing	No example yet
{{youtubemusic_next_song}}	data.extraSettings.youtubemusic_next_song	(Youtube Music) the next song in queue	No example yet
{{youtubemusic_next_image}}	data.extraSettings.youtubemusic_next_image	(Youtube Music) the url for the album art work of the next song in queue	No example yet
{{youtubemusic_next_artist}}	data.extraSettings.youtubemusic_next_artist	(Youtube Music) the artists of the next song in queue	No example yet
{{youtubemusic_next_id}}	data.extraSettings.youtubemusic_next_id	(Youtube Music) the id of the next song in queue	No example yet
{{youtubemusic_next_url}}	data.extraSettings.youtubemusic_next_url	(Youtube Music) the full URL of the next song in queue	No example yet
{{youtubemusic_queue}}	data.extraSettings.youtubemusic_queue	(Youtube Music) the current queue separated by commas	No example yet