Reference Triggers Twitch

Twitch triggers

Also on the Cuebot Docs site.

Ad run

Runs when an ad break starts on your channel. Handy to show a 'be right back' scene.

Setting	What to put in
Ad kind	Automatic: only ads Twitch started by itself. Manual: only ads you or a moderator started. Any: both. Options: Any, Automatic, Manual. Starts as: Any.

Variables you get

Variable	What it holds
%duration%	How long the ad lasts, in seconds
%startedAt%	When it started
%isAutomatic%	True if Twitch started it
%user%	The display name of whoever started it

Type id: twitch.adRun

Announcement

Runs when an announcement is posted in your chat (the highlighted kind a moderator makes with /announce).

Setting	What to put in
Message contains	Only run when the message contains this text, in any capital or small letters. Example: "hello". Leave empty to run for every message.

Variables you get

Variable	What it holds
%message%	The text of the announcement
%user%	The display name of who posted it
%userName%	Their lowercase Twitch login name
%announcementColor%	The colour of the announcement, such as blue or green

Type id: twitch.announcement

Automatic reward redemption

Runs when a viewer uses one of Twitch's built-in channel point rewards, like highlighting a message or unlocking an emote.

Setting	What to put in
Reward type	Only run for this kind of built-in reward, as Twitch names it. Example: "send_highlighted_message". Leave empty to run for every kind.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%rewardType%	Which built-in reward it was
%rewardCost%	How many channel points it cost
%message%	The message that came with it
%emoteName%	The emote involved, if any

Type id: twitch.automaticRewardRedemption

AutoMod message held

Runs when AutoMod holds back a message for a moderator to review.

Variables you get

Variable	What it holds
%user%	The display name of the person who wrote it
%userName%	The lowercase Twitch login name of the person who wrote it
%userId%	The Twitch user number of the person who wrote it
%message%	The held message
%category%	Why AutoMod held it, such as swearing
%level%	How strong the match was

Type id: twitch.automodMessageHeld

AutoMod message updated

Runs when a moderator approves or denies a message AutoMod was holding.

Variables you get

Variable	What it holds
%user%	The display name of the person who wrote it
%userName%	The lowercase Twitch login name of the person who wrote it
%userId%	The Twitch user number of the person who wrote it
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%message%	The held message
%status%	What happened to it, such as approved or denied

Type id: twitch.automodMessageUpdated

Bits badge tier

Runs when a viewer reaches a new bits badge level in your chat, for example after cheering enough bits in total.

Setting	What to put in
Minimum badge tier	Only run for badge tiers at or above this number. Example: 1000. 0 runs for every tier. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	Their lowercase Twitch login name
%tier%	The badge tier they reached, such as 1000
%message%	The message they shared with it

Type id: twitch.bitsBadgeTier

Bits used

Runs when a viewer spends Bits in your channel in any way, including cheers and power-ups.

Setting	What to put in
Minimum bits	Only run when at least this many bits were spent. Example: 50. Starts as: 1.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%bits%	How many bits were spent
%bitsType%	What the bits were used for, as Twitch names it
%message%	The message that came with it

Type id: twitch.bitsUsed

Blocked terms added

Runs when words are added to your blocked words list.

Variables you get

Variable	What it holds
%terms%	The words, separated by commas
%termCount%	How many words
%user%	The display name of whoever changed the list
%fromAutomod%	True if AutoMod added them itself

Type id: twitch.blockedTermsAdded

Blocked terms deleted

Runs when words are removed from your blocked words list.

Variables you get

Variable	What it holds
%terms%	The words, separated by commas
%termCount%	How many words
%user%	The display name of whoever changed the list
%fromAutomod%	True if AutoMod added them itself

Type id: twitch.blockedTermsDeleted

Bot account connected

Runs when your bot account connects to Twitch.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number

Type id: twitch.botConnected

Bot account disconnected

Runs when your bot account loses its connection to Twitch.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number
%reason%	Why it disconnected

Type id: twitch.botDisconnected

Broadcaster chat connected

Runs when Cuebot can read your Twitch chat with your main account.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number

Type id: twitch.broadcasterChatConnected

Broadcaster chat disconnected

Runs when Cuebot can no longer read your Twitch chat with your main account.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number
%reason%	Why it disconnected

Type id: twitch.broadcasterChatDisconnected

Channel point reward

Runs when a viewer spends channel points on one of your rewards. This is the main trigger for channel point rewards.

Setting	What to put in
Reward title	The reward's name exactly as viewers see it, like "Hydrate!". Capital letters do not matter. Leave empty to run for every reward.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%rewardTitle%	The reward's name
%rewardId%	The reward's id
%rewardCost%	How many channel points it cost
%userInput%	The text the viewer typed, if the reward asks for any
%redemptionId%	The id of this redemption
%counter%	How many times this reward has been redeemed
%userCounter%	How many times this viewer has redeemed it

Type id: twitch.rewardRedemption

Charity campaign completed

Runs when your charity fundraiser ends.

Variables you get

Variable	What it holds
%charityName%	The charity's name
%charityDescription%	What the charity does
%charityWebsite%	The charity's web link
%currentAmount%	Money raised so far
%targetAmount%	The money goal
%currency%	The currency, such as USD

Type id: twitch.charityCompleted

Charity campaign progress

Runs when the charity fundraiser total changes.

Variables you get

Variable	What it holds
%charityName%	The charity's name
%charityDescription%	What the charity does
%charityWebsite%	The charity's web link
%currentAmount%	Money raised so far
%targetAmount%	The money goal
%currency%	The currency, such as USD

Type id: twitch.charityProgress

Charity campaign started

Runs when you start a charity fundraiser on your channel.

Variables you get

Variable	What it holds
%charityName%	The charity's name
%charityDescription%	What the charity does
%charityWebsite%	The charity's web link
%currentAmount%	Money raised so far
%targetAmount%	The money goal
%currency%	The currency, such as USD

Type id: twitch.charityStarted

Charity donation

Runs when a viewer donates to your charity fundraiser. Great for a thank-you.

Variables you get

Variable	What it holds
%charityName%	The charity's name
%charityDescription%	What the charity does
%charityWebsite%	The charity's web link
%currentAmount%	Money raised so far
%targetAmount%	The money goal
%currency%	The currency, such as USD
%user%	The display name of the donor
%userName%	Their lowercase Twitch login name
%amount%	How much they donated

Type id: twitch.charityDonation

Chat cleared

Runs when someone clears your whole chat window.

Variables you get

Variable	What it holds
%user%	Your channel's display name

Type id: twitch.chatCleared

Chat command

Runs when someone types a chat command such as !hello. You choose the command word, who may use it, and how often it can run.

Setting	What to put in
Command	The word viewers type, with its ! in front. Example: "!hello". Capital letters do not matter unless you tick Case sensitive. Starts as: !hello.
Match	Starts with: also runs when extra words follow, like "!so bob" (the extra words become %input%). Exact: only runs when the message is just the command. Options: Starts with, Exact. Starts as: Starts with.
Who can use it	Who may use it. Each choice also lets everyone above it in: Subscriber also allows VIPs, moderators and you. Everyone means anybody in chat. Options: Everyone, Subscriber, VIP, Moderator, Broadcaster. Starts as: Everyone.
Global cooldown (seconds)	Seconds to wait before anyone can run this command again. 0 means no waiting. Example: 30. Starts as: 0.
Per-user cooldown (seconds)	Seconds each person must wait before they can run it again. 0 means no waiting. Other people can still use it. Starts as: 0.
Case sensitive	Tick to make "!Hello" and "!hello" count as different commands. Leave unticked to ignore capital letters. Starts as: false.

Variables you get

Variable	What it holds
%command%	The command that was typed, like !hello
%input%	Everything typed after the command, like "bob hi"
%rawInput%	The whole chat message
%input0%	The first word after the command (input1 is the second, and so on)
%inputCount%	How many words were typed after the command
%user%	The display name of the person who typed it
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%isModerator%	True if they are a moderator
%isSubscriber%	True if they are a subscriber
%isVip%	True if they are a VIP
%messageId%	The message's id, useful to reply to it

Type id: twitch.command

Chat message

Runs when someone writes a message in your Twitch chat. Use it to react to words, or to log or read out messages.

Setting	What to put in
Message contains	Only run when the message contains this text, in any capital or small letters. Example: "hello". Leave empty to run for every message.
Ignore the bot account	Tick to skip messages written by your bot account, so your bot cannot trigger itself. Starts as: false.
Ignore shared chat from other channels	Tick to skip messages that come from another channel during a shared chat. Leave unticked to run for those too. Starts as: false.

Variables you get

Variable	What it holds
%message%	The text of the chat message
%user%	The display name of the person who wrote it
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%messageId%	The message's id
%isModerator%	True if they are a moderator
%isVip%	True if they are a VIP
%isSubscriber%	True if they are a subscriber
%isBroadcaster%	True if it is you
%bits%	Bits cheered with the message (0 if none)
%isReply%	True if the message replies to another one
%emoteCount%	How many emotes are in the message
%color%	Their chat name colour
%isSharedChat%	True if it came from another channel in a shared chat

Type id: twitch.chatMessage

Chat message deleted

Runs when a message is removed from your chat by a moderator or by Twitch.

Variables you get

Variable	What it holds
%user%	The display name of the person whose message was removed
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%messageId%	The id of the removed message
%message%	The text of the removed message, if Cuebot saw it before it was removed

Type id: twitch.chatMessageDeleted

Chat mode: emote-only off

Runs when emote-only mode is switched off.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.emoteModeOff

Chat mode: emote-only on

Runs when emote-only mode is switched on, so viewers can only post emotes.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.emoteModeOn

Chat mode: follower-only duration changed

Runs when follower-only mode stays on but the required follow time changes.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.followerModeChanged

Chat mode: follower-only off

Runs when follower-only mode is switched off.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.followerModeOff

Chat mode: follower-only on

Runs when follower-only mode is switched on, so only followers can chat.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.followerModeOn

Chat mode: slow mode delay changed

Runs when slow mode stays on but the waiting time between messages changes.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.slowModeChanged

Chat mode: slow mode off

Runs when slow mode is switched off.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.slowModeOff

Chat mode: slow mode on

Runs when slow mode is switched on, which makes viewers wait between messages.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.slowModeOn

Chat mode: subscriber-only off

Runs when subscriber-only mode is switched off.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.subscriberModeOff

Chat mode: subscriber-only on

Runs when subscriber-only mode is switched on, so only subscribers can chat.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.subscriberModeOn

Chat mode: unique chat off

Runs when unique chat is switched off.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.uniqueModeOff

Chat mode: unique chat on

Runs when unique chat is switched on, which blocks repeated messages.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on now
%followerMode%	True if follower-only is on now
%followerModeDuration%	Minutes a viewer must have followed for
%slowMode%	True if slow mode is on now
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on now
%uniqueChatMode%	True if unique chat is on now

Type id: twitch.uniqueModeOn

Chat settings updated

Runs whenever any chat mode changes (emote-only, slow mode, follower-only, subscriber-only or unique chat). It reports all the current modes.

Variables you get

Variable	What it holds
%emoteMode%	True if emote-only is on
%followerMode%	True if follower-only is on
%followerModeDuration%	Minutes a viewer must have followed for (0 means anyone who follows)
%slowMode%	True if slow mode is on
%slowModeWaitTime%	Seconds between messages in slow mode
%subscriberMode%	True if subscriber-only is on
%uniqueChatMode%	True if unique chat is on

Type id: twitch.chatSettingsUpdated

Cheer

Runs when someone cheers with Bits in your chat. Use the limits to give bigger cheers a bigger reaction.

Setting	What to put in
Minimum bits	Only run when the cheer has at least this many bits. Example: 100. Starts as: 1.
Maximum bits	Only run when the cheer has at most this many bits. 0 means no top limit. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the cheerer (Anonymous if hidden)
%bits%	How many bits they cheered
%message%	The message that came with it
%isAnonymous%	True if they cheered anonymously

Type id: twitch.cheer

Custom power-up redemption

Runs when a viewer redeems one of your own custom power-ups (the ones you made and viewers pay for with Bits).

Setting	What to put in
Power-up	Only run for the power-up with this title or id. Capital letters do not matter. Leave empty to run for every custom power-up.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%rewardTitle%	The title of the power-up
%rewardCost%	How many bits it cost
%userInput%	The text the viewer typed, if it asks for any
%rewardPrompt%	The description you gave it

Type id: twitch.customPowerUpRedemption

Emote pyramid broken

Runs when someone breaks a pyramid that was being built, by posting something that does not fit it.

Variables you get

Variable	What it holds
%user%	The display name of the person whose pyramid was being built
%userName%	Their lowercase Twitch login name
%emote%	The emote or word used
%width%	How wide it got before it broke
%brokenBy%	The display name of the person who broke it
%totalPyramidsBroken%	How many pyramids have been broken so far

Type id: twitch.pyramidBroken

Emote pyramid completed

Runs when one viewer builds a full emote pyramid in chat, like 1, 2, 3 emotes then back down to 1. Good for a cheer or a small reward.

Setting	What to put in
Minimum width	How many emotes wide the top row must be. Example: 3 means 1-2-3-2-1. Pyramids smaller than this are ignored. Starts as: 3.

Variables you get

Variable	What it holds
%user%	The display name of the builder
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%emote%	The emote or word used
%width%	How wide the pyramid got
%totalPyramids%	How many pyramids have been completed so far

Type id: twitch.pyramid

Follow

Runs when someone follows your Twitch channel. Great for a thank-you message or an on-screen alert.

Variables you get

Variable	What it holds
%user%	The display name of the new follower
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%followedAt%	When they followed

Type id: twitch.follow

Gift bundle (community gift)

Runs when someone gifts a bundle of subscriptions at once (a community gift). Good for a big thank-you.

Setting	What to put in
Tier	Only run for this subscription level (1, 2 or 3). Choose Any to run for every level. Options: Any, 1, 2, 3. Starts as: Any.
Minimum gifted	Only run when the bundle has at least this many subs. Example: 10. 1 runs for every bundle. Starts as: 1.

Variables you get

Variable	What it holds
%user%	The display name of the gifter
%total%	How many subs were in the bundle
%tier%	Subscription level: 1, 2 or 3
%cumulativeTotal%	How many subs they have gifted in total

Type id: twitch.giftBomb

Gift paid upgrade

Runs when a viewer who got a gifted sub chooses to keep paying for it themselves.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%gifter%	The display name of whoever first gifted it
%gifterUserName%	That gifter's lowercase login name
%gifterIsAnonymous%	True if the gifter was anonymous

Type id: twitch.giftPaidUpgrade

Gift subscription (each receiver)

Runs once for each person who receives a gifted subscription. Use it to greet the lucky receiver.

Setting	What to put in
Tier	Only run for this subscription level (1, 2 or 3). Choose Any to run for every level. Options: Any, 1, 2, 3. Starts as: Any.

Variables you get

Variable	What it holds
%user%	The display name of the gifter
%recipientUser%	The display name of the person who got the sub
%recipientUserName%	Their lowercase Twitch login name
%tier%	Subscription level: 1, 2 or 3
%durationMonths%	How many months were gifted
%subBombCount%	How many subs were in the same gift bundle (0 if it was a single gift)

Type id: twitch.subGift

Gift subscriptions (whole gift)

Runs once when someone gifts one or more subscriptions to the community. Use it to thank the gifter, not each person who got one.

Setting	What to put in
Minimum gifted	Only run when they gift at least this many subs at once. Example: 5. 1 runs for every gift. Starts as: 1.

Variables you get

Variable	What it holds
%user%	The display name of the gifter (Anonymous if hidden)
%isAnonymous%	True if they gave anonymously
%total%	How many subs they gifted
%tier%	Subscription level: 1, 2 or 3
%cumulativeTotal%	How many subs they have gifted in total

Type id: twitch.giftSub

Goal begin

Runs when you start a creator goal (like a follower goal) on Twitch.

Variables you get

Variable	What it holds
%goalType%	What the goal counts, such as followers or subscriptions
%description%	The goal's description
%currentAmount%	How far along it is
%targetAmount%	The number it is aiming for
%isAchieved%	True if the goal is reached

Type id: twitch.goalBegin

Goal end

Runs when a creator goal ends, whether it was reached or not.

Variables you get

Variable	What it holds
%goalType%	What the goal counts, such as followers or subscriptions
%description%	The goal's description
%currentAmount%	How far along it is
%targetAmount%	The number it is aiming for
%isAchieved%	True if the goal is reached

Type id: twitch.goalEnd

Goal progress

Runs each time your creator goal moves closer. This can happen often.

Variables you get

Variable	What it holds
%goalType%	What the goal counts, such as followers or subscriptions
%description%	The goal's description
%currentAmount%	How far along it is
%targetAmount%	The number it is aiming for
%isAchieved%	True if the goal is reached

Type id: twitch.goalProgress

Guest Star guest update

Runs when a guest in a Guest Star session changes state, for example they are invited, join the stream or are removed.

Setting	What to put in
Guest state	Only run when the guest reaches this state (invited, accepted, ready, backstage, live or removed). Choose Any to run for every change. Options: Any, invited, accepted, ready, backstage, live, removed. Starts as: Any.

Variables you get

Variable	What it holds
%user%	The display name of the guest
%userName%	Their lowercase Twitch login name
%state%	The guest's new state
%sessionId%	The session's id
%slotId%	The guest's place in the session
%host%	The display name of the host

Type id: twitch.guestStarGuestUpdate

Guest Star session begin

Runs when a Guest Star session starts on your channel. Guest Star is a Twitch feature for having guests on stream.

Variables you get

Variable	What it holds
%sessionId%	The session's id
%startedAt%	When it started

Type id: twitch.guestStarSessionBegin

Guest Star session end

Runs when a Guest Star session ends.

Variables you get

Variable	What it holds
%sessionId%	The session's id
%startedAt%	When it started
%endedAt%	When it ended

Type id: twitch.guestStarSessionEnd

Guest Star settings update

Runs when you change your Guest Star settings.

Variables you get

Variable	What it holds
%slotCount%	How many guest places there are
%groupLayout%	The layout chosen for the guests
%isModeratorSendLiveEnabled%	True if moderators may send guests live
%isBrowserSourceAudioEnabled%	True if guest sound reaches the browser source

Type id: twitch.guestStarSettingsUpdate

Hype train end

Runs when a hype train ends. Good for a thank-you to everyone who joined in.

Setting	What to put in
Minimum level	Only run when the train ended at this level or higher. Example: 3. Starts as: 1.

Variables you get

Variable	What it holds
%level%	The hype train's current level
%total%	Total points collected so far
%progress%	Points collected toward the next level
%goal%	Points needed for the next level
%percent%	How full the current level is, 0 to 100
%topContributor%	The display name of the biggest contributor
%topContributorTotal%	How much that person gave
%isGoldenKappa%	True if it is a Golden Kappa train

Type id: twitch.hypeTrainEnd

Hype train level up

Runs when a hype train reaches a new level.

Setting	What to put in
Minimum level	Only run when the new level is at least this number. Example: 3. Starts as: 2.

Variables you get

Variable	What it holds
%level%	The hype train's current level
%total%	Total points collected so far
%progress%	Points collected toward the next level
%goal%	Points needed for the next level
%percent%	How full the current level is, 0 to 100
%topContributor%	The display name of the biggest contributor
%topContributorTotal%	How much that person gave
%isGoldenKappa%	True if it is a Golden Kappa train
%prevLevel%	The level it was before

Type id: twitch.hypeTrainLevelUp

Hype train start

Runs when a hype train starts in your channel.

Variables you get

Variable	What it holds
%level%	The hype train's current level
%total%	Total points collected so far
%progress%	Points collected toward the next level
%goal%	Points needed for the next level
%percent%	How full the current level is, 0 to 100
%topContributor%	The display name of the biggest contributor
%topContributorTotal%	How much that person gave
%isGoldenKappa%	True if it is a Golden Kappa train

Type id: twitch.hypeTrainStart

Hype train update

Runs each time the hype train gets new contributions. This can happen often.

Variables you get

Variable	What it holds
%level%	The hype train's current level
%total%	Total points collected so far
%progress%	Points collected toward the next level
%goal%	Points needed for the next level
%percent%	How full the current level is, 0 to 100
%topContributor%	The display name of the biggest contributor
%topContributorTotal%	How much that person gave
%isGoldenKappa%	True if it is a Golden Kappa train

Type id: twitch.hypeTrainUpdate

Main account connected to Twitch events

Runs when Cuebot connects to Twitch's live event feed for your main account. After this, alerts like follows can arrive.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number

Type id: twitch.broadcasterConnected

Main account lost Twitch events

Runs when the connection to Twitch's live event feed for your main account is lost or closed.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number
%reason%	Why it disconnected

Type id: twitch.broadcasterDisconnected

Main account signed in

Runs when you finish signing in to Twitch with your main account in Cuebot.

Variables you get

Variable	What it holds
%user%	The account's login name
%userName%	The account's login name
%userId%	The account's Twitch user number

Type id: twitch.broadcasterAuthenticated

Moderator added

Runs when someone becomes a moderator of your channel.

Variables you get

Variable	What it holds
%user%	The display name of the new moderator
%userName%	The lowercase Twitch login name of the new moderator
%userId%	The Twitch user number of the new moderator

Type id: twitch.moderatorAdded

Moderator removed

Runs when someone stops being a moderator of your channel.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person

Type id: twitch.moderatorRemoved

Modiversary

Runs when one of your moderators reaches a moderator anniversary, shown in chat by Twitch.

Setting	What to put in
Minimum months	Only run when they have been a moderator at least this many months. Example: 12. 0 runs for every anniversary. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the moderator
%userName%	Their lowercase Twitch login name
%months%	How many months they have been a moderator

Type id: twitch.modiversary

One person's messages wiped

Runs when all the messages of one person are wiped from your chat (a ban or timeout does this).

Variables you get

Variable	What it holds
%user%	The display name of the person whose messages were wiped
%userName%	The lowercase Twitch login name of the person whose messages were wiped
%userId%	The Twitch user number of the person whose messages were wiped

Type id: twitch.userMessagesCleared

Pay it forward

Runs when a viewer gifts a sub to pay forward a sub that someone gifted to them.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%gifter%	The display name of whoever gifted to them first
%gifterIsAnonymous%	True if that gifter was anonymous

Type id: twitch.payItForward

People in chat (every few minutes)

Runs every few minutes with the list of people who are in your chat right now. Needs the permission to read the chat list.

Variables you get

Variable	What it holds
%count%	How many people are in chat
%userLogins%	Their login names in one list, separated by commas
%userIds%	Their user numbers in one list
%isLive%	True if you are live
%viewerCount%	How many are watching
%title%	Your stream title

Type id: twitch.presentViewers

Permitted terms added

Runs when words are added to your permitted words list.

Variables you get

Variable	What it holds
%terms%	The words, separated by commas
%termCount%	How many words
%user%	The display name of whoever changed the list
%fromAutomod%	True if AutoMod added them itself

Type id: twitch.permittedTermsAdded

Permitted terms deleted

Runs when words are removed from your permitted words list.

Variables you get

Variable	What it holds
%terms%	The words, separated by commas
%termCount%	How many words
%user%	The display name of whoever changed the list
%fromAutomod%	True if AutoMod added them itself

Type id: twitch.permittedTermsDeleted

Poll archived

Runs when a finished poll is moved to the archive by Twitch.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The poll's question
%pollId%	The poll's id
%status%	The poll's state, as Twitch names it
%choiceCount%	How many choices it has
%choice0Title%	The first choice (choice1Title is the second, and so on)
%choice0Votes%	Votes for the first choice (choice1Votes and so on)
%totalVotes%	All votes together
%winningChoice%	The choice with the most votes

Type id: twitch.pollArchived

Poll completed

Runs when a poll ends normally and the result is final. Good for announcing the winner.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The poll's question
%pollId%	The poll's id
%status%	The poll's state, as Twitch names it
%choiceCount%	How many choices it has
%choice0Title%	The first choice (choice1Title is the second, and so on)
%choice0Votes%	Votes for the first choice (choice1Votes and so on)
%totalVotes%	All votes together
%winningChoice%	The choice with the most votes

Type id: twitch.pollCompleted

Poll created

Runs when a poll starts in your channel. Handy to tell viewers to go vote.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The poll's question
%pollId%	The poll's id
%status%	The poll's state, as Twitch names it
%choiceCount%	How many choices it has
%choice0Title%	The first choice (choice1Title is the second, and so on)
%choice0Votes%	Votes for the first choice (choice1Votes and so on)
%totalVotes%	All votes together
%winningChoice%	The choice with the most votes

Type id: twitch.pollCreated

Poll terminated

Runs when a poll is ended early by you or a moderator.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The poll's question
%pollId%	The poll's id
%status%	The poll's state, as Twitch names it
%choiceCount%	How many choices it has
%choice0Title%	The first choice (choice1Title is the second, and so on)
%choice0Votes%	Votes for the first choice (choice1Votes and so on)
%totalVotes%	All votes together
%winningChoice%	The choice with the most votes

Type id: twitch.pollTerminated

Poll updated

Runs each time votes come in on a running poll. This can happen very often.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The poll's question
%pollId%	The poll's id
%status%	The poll's state, as Twitch names it
%choiceCount%	How many choices it has
%choice0Title%	The first choice (choice1Title is the second, and so on)
%choice0Votes%	Votes for the first choice (choice1Votes and so on)
%totalVotes%	All votes together
%winningChoice%	The choice with the most votes

Type id: twitch.pollUpdated

Power-up redemption

Runs when a viewer uses Bits on a power-up, such as a giant emote, a celebration or a message effect.

Setting	What to put in
Power-up type	Pick one kind of power-up, or Any to run for all of them. Options: Any, gigantify_an_emote, celebration, message_effect. Starts as: Any.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%bits%	How many bits it cost
%powerUpType%	Which power-up it was
%powerUpEmoteName%	The emote used, if any
%message%	The message that came with it

Type id: twitch.powerUp

Prediction canceled

Runs when a prediction is canceled and the points are given back.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The prediction's question
%predictionId%	The prediction's id
%status%	The prediction's state, as Twitch names it
%outcome0Title%	The first outcome (outcome1Title is the second, and so on)
%outcome0Users%	People who bet on the first outcome (outcome1Users and so on)
%outcome0ChannelPoints%	Points bet on the first outcome (outcome1ChannelPoints and so on)
%totalUsers%	How many people bet
%totalChannelPoints%	All points bet together
%winningOutcome%	The winning outcome (only once it is decided)

Type id: twitch.predictionCanceled

Prediction completed

Runs when a prediction is decided and a winning outcome is picked.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The prediction's question
%predictionId%	The prediction's id
%status%	The prediction's state, as Twitch names it
%outcome0Title%	The first outcome (outcome1Title is the second, and so on)
%outcome0Users%	People who bet on the first outcome (outcome1Users and so on)
%outcome0ChannelPoints%	Points bet on the first outcome (outcome1ChannelPoints and so on)
%totalUsers%	How many people bet
%totalChannelPoints%	All points bet together
%winningOutcome%	The winning outcome (only once it is decided)

Type id: twitch.predictionCompleted

Prediction created

Runs when a prediction starts and viewers can place their bets.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The prediction's question
%predictionId%	The prediction's id
%status%	The prediction's state, as Twitch names it
%outcome0Title%	The first outcome (outcome1Title is the second, and so on)
%outcome0Users%	People who bet on the first outcome (outcome1Users and so on)
%outcome0ChannelPoints%	Points bet on the first outcome (outcome1ChannelPoints and so on)
%totalUsers%	How many people bet
%totalChannelPoints%	All points bet together
%winningOutcome%	The winning outcome (only once it is decided)

Type id: twitch.predictionCreated

Prediction locked

Runs when betting on a prediction closes and no more bets can be placed.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The prediction's question
%predictionId%	The prediction's id
%status%	The prediction's state, as Twitch names it
%outcome0Title%	The first outcome (outcome1Title is the second, and so on)
%outcome0Users%	People who bet on the first outcome (outcome1Users and so on)
%outcome0ChannelPoints%	Points bet on the first outcome (outcome1ChannelPoints and so on)
%totalUsers%	How many people bet
%totalChannelPoints%	All points bet together
%winningOutcome%	The winning outcome (only once it is decided)

Type id: twitch.predictionLocked

Prediction updated

Runs each time bets come in on a running prediction. This can happen very often.

Setting	What to put in
Title contains	Only run when the title contains this text, in any capital or small letters. Leave empty to run for every one.

Variables you get

Variable	What it holds
%title%	The prediction's question
%predictionId%	The prediction's id
%status%	The prediction's state, as Twitch names it
%outcome0Title%	The first outcome (outcome1Title is the second, and so on)
%outcome0Users%	People who bet on the first outcome (outcome1Users and so on)
%outcome0ChannelPoints%	Points bet on the first outcome (outcome1ChannelPoints and so on)
%totalUsers%	How many people bet
%totalChannelPoints%	All points bet together
%winningOutcome%	The winning outcome (only once it is decided)

Type id: twitch.predictionUpdated

Prime paid upgrade

Runs when a viewer changes their free Prime sub into a paid subscription.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	Their lowercase Twitch login name
%tier%	The paid level they chose: 1, 2 or 3

Type id: twitch.primePaidUpgrade

Raid

Runs when another streamer raids your channel and sends their viewers to you. Perfect for a welcome or a shout-out.

Setting	What to put in
Minimum viewers	Only run when the raid brings at least this many viewers. Example: 10. 0 runs for every raid. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the raiding streamer
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%viewers%	How many viewers came with the raid

Type id: twitch.raid

Raid about to start (you)

Runs when you start a raid from Cuebot, before it happens. Handy for a goodbye message to your chat.

Variables you get

Variable	What it holds
%user%	The display name of the channel you are raiding
%userName%	Their lowercase Twitch login name
%viewers%	Roughly how many viewers go along (your last viewer count)

Type id: twitch.raidStart

Raid cancelled

Runs when a raid you started is cancelled before it happens.

Variables you get

Variable	What it holds
%raidUser%	The display name of the channel you were about to raid
%raidUserName%	Their lowercase Twitch login name

Type id: twitch.raidCancelled

Raid went through (you)

Runs when your raid actually goes through and your viewers move to the other channel.

Variables you get

Variable	What it holds
%user%	The display name of the channel you raided
%userName%	Their lowercase Twitch login name
%viewers%	How many viewers went along

Type id: twitch.raidSend

Resubscription

Runs when someone renews their subscription and shares it in chat.

Setting	What to put in
Tier	Only run for this subscription level (1, 2 or 3). Choose Any to run for every level. Options: Any, 1, 2, 3. Starts as: Any.
Minimum cumulative months	Only run when they have subscribed at least this many months in total. Example: 12. 0 runs for every resub. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the subscriber
%userName%	Their lowercase Twitch login name
%tier%	Subscription level: 1, 2 or 3
%message%	The message they wrote
%cumulativeMonths%	How many months they have subscribed in total
%streakMonths%	Months in a row without a break
%durationMonths%	How many months they paid for this time

Type id: twitch.resub

Reward created

Runs when you create a new channel point reward on Twitch.

Variables you get

Variable	What it holds
%rewardTitle%	The new reward's name
%rewardId%	Its id
%rewardCost%	Its cost in channel points
%rewardPrompt%	Its description
%isEnabled%	True if it is turned on

Type id: twitch.rewardCreated

Reward deleted

Runs when you delete a channel point reward on Twitch.

Variables you get

Variable	What it holds
%rewardTitle%	The deleted reward's name
%rewardId%	Its id
%rewardCost%	Its cost in channel points

Type id: twitch.rewardDeleted

Reward redemption updated

Runs when you accept or reject a viewer's reward after they redeemed it, for rewards that wait in your queue.

Setting	What to put in
Reward title	The reward's name exactly as viewers see it. Capital letters do not matter. Leave empty to run for every reward.
Status	Run only when the reward was fulfilled (accepted) or canceled (rejected). Choose Any to run for both. Options: Any, fulfilled, canceled. Starts as: Any.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%rewardTitle%	The reward's name
%rewardCost%	How many channel points it cost
%userInput%	The text the viewer typed
%status%	fulfilled or canceled
%redemptionId%	The id of this redemption

Type id: twitch.rewardRedemptionUpdated

Reward updated

Runs when you change a channel point reward on Twitch, for example its cost or if it is paused.

Setting	What to put in
Reward title	Only run for the reward with this name. Capital letters do not matter. Leave empty to run for every reward.

Variables you get

Variable	What it holds
%rewardTitle%	The reward's name
%rewardId%	Its id
%rewardCost%	Its cost in channel points
%isEnabled%	True if it is turned on
%isPaused%	True if it is paused

Type id: twitch.rewardUpdated

Shared chat session begin

Runs when a shared chat session starts, so your chat is joined with one or more other channels.

Variables you get

Variable	What it holds
%user%	The display name of the host channel
%sessionId%	The shared chat session's id
%participants%	The login names of the channels taking part, separated by commas
%participantCount%	How many channels take part
%isHost%	True if your channel is the host

Type id: twitch.sharedChatBegin

Shared chat session end

Runs when a shared chat session ends.

Variables you get

Variable	What it holds
%user%	The display name of the host channel
%sessionId%	The shared chat session's id
%participants%	The login names of the channels taking part, separated by commas
%participantCount%	How many channels take part
%isHost%	True if your channel is the host

Type id: twitch.sharedChatEnd

Shared chat session update

Runs when channels join or leave a shared chat session you are in.

Variables you get

Variable	What it holds
%user%	The display name of the host channel
%sessionId%	The shared chat session's id
%participants%	The login names of the channels taking part, separated by commas
%participantCount%	How many channels take part
%isHost%	True if your channel is the host

Type id: twitch.sharedChatUpdate

Shared chat: announcement

Runs when an announcement is posted in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%message%	The text of the announcement
%announcementColor%	The announcement's colour
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatAnnouncement

Shared chat: gift bomb

Runs when someone gifts a bundle of subs in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%total%	How many subs were gifted
%tier%	Subscription level: 1, 2 or 3
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatGiftBomb

Shared chat: gift paid upgrade

Runs when a viewer keeps a gifted sub by paying for it, in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%gifter%	The display name of whoever first gifted it
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatGiftPaidUpgrade

Shared chat: gift subscription

Runs when someone receives a gifted sub in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%recipientUser%	The display name of who got the sub
%tier%	Subscription level: 1, 2 or 3
%durationMonths%	Months gifted
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatSubGift

Shared chat: message deleted

Runs when a message is deleted in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%messageId%	The id of the deleted message
%message%	The text of the deleted message
%moderator%	The display name of who deleted it
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatMessageDeleted

Shared chat: modiversary

Runs when a moderator reaches an anniversary in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%months%	Months as a moderator
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatModiversary

Shared chat: pay it forward

Runs when a viewer pays forward a gifted sub, in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%gifter%	The display name of whoever gifted to them first
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatPayItForward

Shared chat: prime paid upgrade

Runs when a viewer turns a Prime sub into a paid one, in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%tier%	The paid level: 1, 2 or 3
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatPrimePaidUpgrade

Shared chat: raid

Runs when a channel is raided in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%raider%	The display name of the raiding streamer
%viewers%	How many viewers came
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatRaid

Shared chat: resubscription

Runs when someone renews a subscription in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%tier%	Subscription level: 1, 2 or 3
%cumulativeMonths%	Months subscribed in total
%streakMonths%	Months in a row
%message%	Their message
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatResub

Shared chat: subscription

Runs when someone subscribes in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%tier%	Subscription level: 1, 2 or 3
%isPrime%	True if it is a free Prime sub
%durationMonths%	Months paid for
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatSub

Shared chat: user banned

Runs when someone is banned in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%moderator%	The display name of who banned them
%reason%	The reason given
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatUserBanned

Shared chat: user timed out

Runs when someone gets a timeout in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%moderator%	The display name of who did it
%reason%	The reason given
%duration%	How many seconds the timeout has left
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatUserTimedOut

Shared chat: user unbanned

Runs when someone is unbanned in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%moderator%	The display name of who unbanned them
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatUserUnbanned

Shared chat: user untimed out

Runs when a timeout is lifted early in another channel of a shared chat you are in.

Variables you get

Variable	What it holds
%user%	The display name of the person involved
%userName%	Their lowercase Twitch login name
%moderator%	The display name of who lifted it
%sourceBroadcaster%	The display name of the channel where it happened
%sourceBroadcasterUserName%	That channel's lowercase login name

Type id: twitch.sharedChatUserUntimedOut

Shield mode begin

Runs when Shield Mode is switched on, Twitch's emergency protection against trolls and spam.

Variables you get

Variable	What it holds
%user%	The display name of the moderator who turned it on
%startedAt%	When it started

Type id: twitch.shieldModeBegin

Shield mode end

Runs when Shield Mode is switched off.

Variables you get

Variable	What it holds
%user%	The display name of the moderator who turned it off
%endedAt%	When it ended

Type id: twitch.shieldModeEnd

Shoutout created

Runs when you or a moderator give another channel a shoutout using Twitch's shoutout feature.

Variables you get

Variable	What it holds
%user%	The display name of the channel that got the shoutout
%userName%	Their lowercase Twitch login name
%moderator%	The display name of who gave it
%viewers%	How many viewers that channel has

Type id: twitch.shoutoutCreated

Shoutout received

Runs when another channel gives your channel a shoutout.

Variables you get

Variable	What it holds
%user%	The display name of the channel that gave it
%userName%	Their lowercase Twitch login name
%viewers%	How many viewers that channel has

Type id: twitch.shoutoutReceived

Stream offline

Runs when your stream ends. Handy for a goodbye message or to switch things off.

Variables you get

Variable	What it holds
%user%	Your channel's display name
%endedAt%	When the stream ended

Type id: twitch.streamOffline

Stream online

Runs when your stream goes live. Handy for a start-of-stream message, scene or lights.

Variables you get

Variable	What it holds
%user%	Your channel's display name
%streamType%	The kind of stream Twitch reports, such as live
%startedAt%	When the stream started
%game%	The category you are streaming, if known
%tagsDelimited%	Your stream tags in one line

Type id: twitch.streamOnline

Stream update (title / category)

Runs when you change your stream title or category while connected.

Setting	What to put in
Category is	Only run when the new category has exactly this name, like "Just Chatting". Capital letters do not matter. Leave empty to run for every update.

Variables you get

Variable	What it holds
%title%	Your new stream title
%categoryName%	Your new category
%oldStatus%	The title you had before
%oldGameName%	The category you had before
%statusUpdate%	True if the title changed
%gameUpdate%	True if the category changed
%language%	The stream language

Type id: twitch.streamUpdate

Sub counter rollover

Runs when Cuebot's sub counter reaches its goal number and starts over. Good for a milestone celebration.

Variables you get

Variable	What it holds
%rollover%	The number the counter counts up to
%rolloverCount%	How many times it has started over
%subCounter%	What the counter shows after starting over

Type id: twitch.subCounterRollover

Subscription

Runs when someone subscribes to your channel for the first time. Great for a thank-you alert.

Setting	What to put in
Tier	Only run for this subscription level (1, 2 or 3). Choose Any to run for every level. Options: Any, 1, 2, 3. Starts as: Any.

Variables you get

Variable	What it holds
%user%	The display name of the new subscriber
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number
%tier%	Subscription level: 1, 2 or 3
%isGift%	True if someone gifted it to them

Type id: twitch.sub

Suspicious user message

Runs when someone Twitch marks as suspicious writes a message in your chat.

Variables you get

Variable	What it holds
%user%	The display name of the chatter
%userName%	The lowercase Twitch login name of the chatter
%userId%	The Twitch user number of the chatter
%message%	What they wrote
%lowTrustStatus%	How they are treated, as Twitch names it
%types%	Why they are flagged, separated by commas
%banEvasionEvaluation%	Twitch's guess whether they dodge a ban

Type id: twitch.suspiciousUserMessage

Suspicious user update

Runs when a moderator changes how a suspicious chatter is treated (for example monitored or restricted).

Variables you get

Variable	What it holds
%user%	The display name of the chatter
%userName%	The lowercase Twitch login name of the chatter
%userId%	The Twitch user number of the chatter
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%lowTrustStatus%	How they are now treated, as Twitch names it

Type id: twitch.suspiciousUserUpdate

Unban request approved

Runs when a moderator approves an unban request.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	The lowercase Twitch login name of the viewer
%userId%	The Twitch user number of the viewer
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%resolutionText%	The moderator's note, if any

Type id: twitch.unbanRequestApproved

Unban request created

Runs when a banned viewer asks to be unbanned.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	The lowercase Twitch login name of the viewer
%userId%	The Twitch user number of the viewer
%message%	What they wrote
%requestId%	The request's id

Type id: twitch.unbanRequestCreated

Unban request denied

Runs when a moderator denies an unban request.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	The lowercase Twitch login name of the viewer
%userId%	The Twitch user number of the viewer
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%resolutionText%	The moderator's note, if any

Type id: twitch.unbanRequestDenied

Upcoming ad (5 to 1 minutes before)

Runs once a minute in the last 5 minutes before your next ad. Cuebot has to look at your ad schedule, which you can turn off in the Twitch settings.

Setting	What to put in
Minutes before	Only run when this many minutes are left before the ad (5, 4, 3, 2 or 1). Choose Any to run for every warning. Options: Any, 5, 4, 3, 2, 1. Starts as: Any.

Variables you get

Variable	What it holds
%minutes%	How many minutes are left before the ad
%adLength%	How long the ad will be, in seconds
%nextAdAt%	When the ad is due
%snoozeCount%	How many snoozes you have left

Type id: twitch.upcomingAd

User banned

Runs when someone is banned from your channel.

Variables you get

Variable	What it holds
%user%	The display name of the banned person
%userName%	The lowercase Twitch login name of the banned person
%userId%	The Twitch user number of the banned person
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%reason%	The reason given, if any

Type id: twitch.userBanned

User timed out

Runs when someone gets a timeout in your channel.

Setting	What to put in
Minimum duration (seconds)	Only run when the timeout lasts at least this many seconds. Example: 600. 0 runs for every timeout. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%reason%	The reason given, if any
%duration%	How long the timeout lasts, in seconds

Type id: twitch.userTimedOut

User unbanned

Runs when someone is unbanned from your channel.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator

Type id: twitch.userUnbanned

User untimed out

Runs when a timeout is lifted early. Cuebot only knows about timeouts it saw happen while it was running.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator

Type id: twitch.userUntimedOut

User warned

Runs when a moderator sends a warning to a chatter.

Variables you get

Variable	What it holds
%user%	The display name of the warned person
%userName%	The lowercase Twitch login name of the warned person
%userId%	The Twitch user number of the warned person
%moderator%	The display name of the moderator who did it
%moderatorUserName%	The lowercase login name of that moderator
%reason%	The reason given
%chatRulesCited%	The chat rules mentioned, separated by commas

Type id: twitch.userWarned

Viewer count update

Runs every minute or so while you are live, with the current number of viewers. How often is set in the Twitch settings.

Setting	What to put in
Minimum viewers	Only run when at least this many people are watching. Example: 100. 0 runs every time. Starts as: 0.

Variables you get

Variable	What it holds
%viewers%	How many people are watching now
%title%	Your stream title
%gameName%	Your category
%startedAt%	When the stream started

Type id: twitch.viewerCountUpdate

VIP added

Runs when someone becomes a VIP on your channel.

Variables you get

Variable	What it holds
%user%	The display name of the new VIP
%userName%	The lowercase Twitch login name of the new VIP
%userId%	The Twitch user number of the new VIP

Type id: twitch.vipAdded

VIP removed

Runs when someone stops being a VIP on your channel.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person

Type id: twitch.vipRemoved

Warning acknowledged

Runs when a warned chatter confirms they read the warning, so they can chat again.

Variables you get

Variable	What it holds
%user%	The display name of the person
%userName%	The lowercase Twitch login name of the person
%userId%	The Twitch user number of the person

Type id: twitch.warningAcknowledged

Watch streak shared

Runs when a viewer shares their watch streak in chat (how many streams in a row they came to).

Setting	What to put in
Minimum streak	Only run when the streak is at least this many streams. Example: 5. 0 runs for every streak. Starts as: 0.

Variables you get

Variable	What it holds
%user%	The display name of the viewer
%userName%	Their lowercase Twitch login name
%streak%	How many streams in a row they have watched
%channelPointsAwarded%	Channel points they got for sharing it
%message%	Their message

Type id: twitch.watchStreak

Whisper (bot account)

Runs when someone sends a private whisper to your bot account (the second account you connected for the bot).

Setting	What to put in
Message contains	Only run when the message contains this text, in any capital or small letters. Example: "hello". Leave empty to run for every message.

Variables you get

Variable	What it holds
%message%	The text of the whisper
%user%	The display name of the person who sent it
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number

Type id: twitch.botWhisper

Whisper (broadcaster)

Runs when someone sends a private whisper to your own Twitch account.

Setting	What to put in
Message contains	Only run when the message contains this text, in any capital or small letters. Example: "hello". Leave empty to run for every message.

Variables you get

Variable	What it holds
%message%	The text of the whisper
%user%	The display name of the person who sent it
%userName%	Their lowercase Twitch login name
%userId%	Their Twitch user number

Type id: twitch.whisper