Reference Sub actions Twitch

Twitch sub-actions

Also on the Cuebot Docs site.

Add blocked term

Adds a word or phrase to your channel's blocked list, so messages with it are held back.

Setting	What to put in
Term	The word or phrase to block, like "badword".

Variables it adds

Variable	What it holds
%blockedTermId%	Twitch's id for the blocked term

Type id: twitch.addBlockedTerm

Add channel tag

Adds one tag to your stream tags and keeps the ones you already have.

Setting	What to put in
Tag	The tag to add, like "Cozy".

Type id: twitch.addTag

Add moderator

Makes a viewer a moderator of your channel.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Type id: twitch.addModerator

Add suspicious status

Marks a viewer as suspicious, so their messages are flagged or limited. Good against ban evaders.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Status	Active monitoring flags the viewer's messages for your moderators. Restricted keeps their messages away from everyone else. Options: Active Monitoring, Restricted. Starts as: Active Monitoring.

Variables it adds

Variable	What it holds
%suspiciousUser%	The display name of the marked person
%suspiciousUserId%	Their Twitch id
%suspiciousStatus%	The status they now have
%suspiciousStatusResult%	True when it worked

Type id: twitch.addSuspiciousStatus

Add VIP

Makes a viewer a VIP on your channel.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Type id: twitch.addVip

Approve or deny AutoMod message

Allows or denies a chat message that AutoMod is holding back for review.

Setting	What to put in
Held message id	The id of the held message. The default %messageId% is the message from the AutoMod trigger. Starts as: %messageId%.
Decision	Allow lets the message appear in chat. Deny throws it away. Options: Allow, Deny. Starts as: Allow.

Type id: twitch.resolveAutomod

Ban user

Bans a viewer from your channel for good. They can no longer chat or watch in chat.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Reason	Why they are banned, like "Spam". Moderators can see it. Can be empty.

Variables it adds

Variable	What it holds
%bannedUser%	The display name of the person who was banned
%bannedUserName%	Their login name
%bannedUserId%	Their Twitch id
%banResult%	True when the ban worked

Type id: twitch.ban

Cancel active prediction (refund) (cancelled, prediction.*)

Cancels the running prediction and gives every viewer their channel points back.

Variables it adds

Variable	What it holds
%cancelled%	True when the prediction was cancelled
%prediction.Title%	The question

Type id: twitch.cancelPrediction

Cancel raid

Stops a raid that you started but that has not left yet.

Type id: twitch.cancelRaid

Chat mode: emote-only

Turns emote-only chat on or off. In this mode viewers can only post emotes.

Setting	What to put in
Enabled	Tick to turn it on, untick to turn it off. Starts as: true.

Type id: twitch.emoteOnly

Chat mode: follower-only

Turns followers-only chat on or off. In this mode only people who follow you can chat.

Setting	What to put in
Enabled	Tick to turn it on, untick to turn it off. Starts as: true.
Followed for at least (minutes)	How long someone must have followed before chatting, in minutes. 0 means any follower. Up to 129600 (3 months). Only used when turning it on. Starts as: 0.

Type id: twitch.followerMode

Chat mode: slow mode

Turns slow mode on or off. In this mode each viewer must wait between messages.

Setting	What to put in
Enabled	Tick to turn it on, untick to turn it off. Starts as: true.
Delay (seconds)	How long each viewer waits between messages, in seconds (3 to 120). Only used when turning it on. Starts as: 30.

Type id: twitch.slowMode

Chat mode: subscriber-only

Turns subscribers-only chat on or off. In this mode only subscribers can chat.

Setting	What to put in
Enabled	Tick to turn it on, untick to turn it off. Starts as: true.

Type id: twitch.subscriberMode

Chat mode: unique chat

Turns unique chat on or off. In this mode a viewer cannot post the same message twice in a row.

Setting	What to put in
Enabled	Tick to turn it on, untick to turn it off. Starts as: true.

Type id: twitch.uniqueChat

Clear channel tags

Removes all of your stream tags.

Type id: twitch.clearTags

Clear chat

Wipes all messages from your Twitch chat at once.

Variables it adds

Variable	What it holds
%clearSuccess%	True when the chat was cleared

Type id: twitch.clearChat

Configure rewards

Turns, pauses and resumes many rewards at once, by name or by group. Only rewards that Cuebot created can be changed.

Setting	What to put in
Enable	Rewards to turn on. Reward names, reward ids or group names, one per line. A group name changes every reward in that group.
Disable	Rewards to turn off. Reward names, reward ids or group names, one per line. A group name changes every reward in that group.
Pause	Rewards to pause. Reward names, reward ids or group names, one per line. A group name changes every reward in that group.
Unpause	Rewards to resume. Reward names, reward ids or group names, one per line. A group name changes every reward in that group.
Disable rewards that are in no group	Tick to also turn off every reward that is on and has no group and is not listed above. Starts as: false.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many listed rewards could not be changed

Type id: twitch.configureRewards

Create clip

Makes a clip of the last moments of your stream and saves its web links for the next steps.

Setting	What to put in
Account for stream delay	Tick if your stream has a delay set on Twitch, so the clip matches what your viewers saw. Starts as: false.

Variables it adds

Variable	What it holds
%clipId%	Twitch's id for the new clip
%clipUrl%	The web link to watch the clip
%clipEditUrl%	The web link to edit the clip
%createClipSuccess%	True when the clip was made

Type id: twitch.createClip

Create poll

Starts a poll in your Twitch chat for viewers to vote on.

Setting	What to put in
Question	The question, like "What game next?".
Choices	One per line (or separated by |). The answers viewers can pick, 2 to 5 of them.
Duration (seconds)	How long the poll runs, in seconds (15 to 1800). Starts as: 60.
Channel points per extra vote	How many channel points an extra vote costs. 0 means viewers cannot buy extra votes. Starts as: 0.

Variables it adds

Variable	What it holds
%pollId%	Twitch's id for the poll
%success%	True when the poll started

Type id: twitch.createPoll

Create prediction (predictionId, success, prediction.Id)

Starts a prediction where viewers bet channel points on what will happen.

Setting	What to put in
Question	The question, like "Will I win?".
Outcomes	One per line (or separated by |). The possible results viewers can bet on, 2 to 10 of them.
Submission window (seconds)	How long viewers can place bets, in seconds (30 to 1800). Starts as: 120.

Variables it adds

Variable	What it holds
%predictionId%	Twitch's id for the prediction
%success%	True when the prediction started

Type id: twitch.createPrediction

Create reward

Creates a new channel points reward on your channel.

Setting	What to put in
Title	The name of the reward, like "Hydrate".
Cost	How many channel points it costs (at least 1). Starts as: 100.
Prompt	The text viewers see when they open the reward. Can be empty.
User input required	Tick if the viewer must type a message when they redeem it. Starts as: false.
Enabled	Tick to make the reward available right away. Starts as: true.

Variables it adds

Variable	What it holds
%createdRewardId%	Twitch's id for the new reward

Type id: twitch.createReward

Create stream marker

Puts a marker into your stream at this moment, so you can find the spot later in your video.

Setting	What to put in
Description	A short note for the marker, like "Epic fail". It can be empty.

Variables it adds

Variable	What it holds
%markerId%	Twitch's id for the marker
%markerPosition%	How many seconds into the stream the marker is
%streamMarkerDescription%	The note on the marker

Type id: twitch.createMarker

Delete chat message

Deletes one message from your Twitch chat, for example one that broke a rule.

Setting	What to put in
Message id	The id of the chat message. The default %messageId% is the message that started the action. Starts as: %messageId%.

Type id: twitch.deleteMessage

End active poll

Ends the poll that is running now.

Setting	What to put in
How	End and show results: viewers see who won. End and hide results: the poll disappears without showing the results. Options: End and show results, End and hide results. Starts as: End and show results.

Type id: twitch.endPoll

Get ad schedule (nextAdAt, prerollFreeTime, snoozeCount...)

Looks up when your next ad is due and how many snoozes you have, and saves it for the next steps.

Variables it adds

Variable	What it holds
%nextAdAt%	When the next ad starts
%lastAdAt%	When the last ad ran
%adDuration%	How long the next ad is, in seconds
%prerollFreeTime%	Seconds left without pre-roll ads for new viewers
%snoozeCount%	How many snoozes you have left
%snoozeRefreshAt%	When you get a snooze back

Type id: twitch.getAdSchedule

Get broadcaster info

Saves facts about your own channel and your bot account, like your name and whether you are an affiliate, for the next steps.

Variables it adds

Variable	What it holds
%broadcasterUser%	Your display name
%broadcasterUserName%	Your login name
%broadcasterUserId%	Your Twitch id
%broadcasterType%	affiliate, partner or empty
%broadcasterIsAffiliate%	True if you are an affiliate
%broadcasterIsPartner%	True if you are a partner
%broadcasterProfileImageUrl%	The web link of your profile picture
%botUserName%	Your bot account's login name
%botUserId%	Your bot account's Twitch id

Type id: twitch.getBroadcasterInfo

Get channel info (channelTitle, channelGame, channelTags...)

Looks up a channel's title, category and tags and saves them for the next steps. Good for shout-outs.

Setting	What to put in
Channel	The channel to look up: a login name like "coolstreamer" or id:12345. Leave empty for your own channel.

Variables it adds

Variable	What it holds
%channelUser%	The channel's display name
%channelUserName%	The channel's login name
%channelTitle%	The stream title
%channelGame%	The category (game) name
%channelTags%	The tags, separated by commas
%channelLanguage%	The stream language
%channelContentLabels%	The content warning labels
%channelIsBrandedContent%	True if it is marked as branded content

Type id: twitch.getChannelInfo

Get charity campaign

Looks up your running charity campaign and saves the amounts for the next steps.

Variables it adds

Variable	What it holds
%charityActive%	True if a campaign is running
%charityName%	The charity's name
%charityCurrent%	How much was raised so far
%charityTarget%	The goal amount
%charityCurrency%	The currency, like USD

Type id: twitch.getCharityCampaign

Get clip download URLs (clipDownloadUrl, clipPortraitDownloadUrl, clipDownload0.., clipDownloadCount)

Looks up download links for clips of your channel, so you can save or reuse them.

Setting	What to put in
Clip id	The id of one of your clips. The default %clipId% is the clip you just made. For several clips, separate up to 10 ids with commas. Starts as: %clipId%.

Variables it adds

Variable	What it holds
%clipDownloadUrl%	Download link of the first clip (wide video)
%clipPortraitDownloadUrl%	Download link of the first clip (tall video)
%clipDownloadCount%	How many clips were found
%clipDownload0.landscapeUrl%	Wide download link of the first clip. Use 1, 2, ... for the next ones
%clipDownload0.portraitUrl%	Tall download link of the first clip

Type id: twitch.getClipDownloadUrls

Get follow age

Checks if a viewer follows you and for how long, and saves it for the next steps.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%isFollowing%	True if they follow you
%followedAt%	When they started following
%followAgeDays%	How many days they have followed
%followAge%	A short text, like 2 years, 3 months
%followAgeLong%	A full text, like 1 year, 2 months, 5 days
%followDate%	The day they followed, in words

Type id: twitch.getFollowAge

Get follower count

Looks up how many followers you have and who followed last, and saves it for the next steps.

Variables it adds

Variable	What it holds
%followerCount%	Your number of followers
%latestFollower%	The display name of your newest follower
%latestFollowerUserName%	Their login name

Type id: twitch.getFollowerCount

Get latest poll (pollId, pollTitle, pollStatus, pollChoice0.., active, poll.*)

Looks up your latest poll and saves its question, answers and votes for the next steps.

Variables it adds

Variable	What it holds
%pollId%	Twitch's id for the poll
%pollTitle%	The question
%pollStatus%	The poll's state, like ACTIVE or COMPLETED
%active%	True if the poll is still running
%pollChoiceCount%	How many answers there are
%pollChoice0%	The first answer. Use 1, 2, ... for the next ones
%pollChoice0Votes%	Votes for the first answer
%poll.totalVotes%	All votes together
%poll.DurationRemaining%	Seconds left

Type id: twitch.getPoll

Get latest prediction (predictionId, predictionTitle, predictionStatus, predictionOutcome0.., active, prediction.*)

Looks up your latest prediction and saves its question, results and bets for the next steps.

Variables it adds

Variable	What it holds
%predictionId%	Twitch's id for the prediction
%predictionTitle%	The question
%predictionStatus%	The prediction's state, like ACTIVE, LOCKED or RESOLVED
%active%	True if betting is still open
%predictionOutcomeCount%	How many results there are
%predictionOutcome0%	The first result. Use 1, 2, ... for the next ones
%predictionOutcome0Users%	How many viewers bet on the first result
%predictionOutcome0Points%	How many channel points were bet on the first result
%prediction.winningOutcome.title%	The winning result, once there is one

Type id: twitch.getPrediction

Get latest subscriber (latestSubscriber.userName, .userId, .tier, .isGift...)

Looks up who subscribed last, as seen by Cuebot, and saves it for the next steps.

Variables it adds

Variable	What it holds
%latestSubscriber.userName%	Their display name
%latestSubscriber.userLogin%	Their login name
%latestSubscriber.userId%	Their Twitch id
%latestSubscriber.tier%	Their tier, like Tier1
%latestSubscriber.isGift%	True if it was a gift
%latestSubscriber.at%	When they subscribed

Type id: twitch.getLatestSubscriber

Get people in chat

Looks up who is in your chat right now and saves the count and the names for the next steps.

Variables it adds

Variable	What it holds
%presentViewerCount%	How many people are in chat
%presentViewers%	Their login names, separated by commas

Type id: twitch.getPresentViewers

Get person in chat by number

Picks one person from the people in chat right now by their place in the list, and saves their name.

Setting	What to put in
Index	Which person to pick. 0 is the first, 1 the second, and so on. A variable like %randomNumber% also works. Starts as: 0.

Variables it adds

Variable	What it holds
%presentUser%	Their display name (false if nobody is at that place)
%presentUserName%	Their login name
%presentUserId%	Their Twitch id
%presentUsersCount%	How many people are in chat

Type id: twitch.getPresentUser

Get pinned chat message (isPinned, pinnedMessage, pinnedMessageId, pinnedUser...)

Looks up the chat message that is pinned right now and saves its details for the next steps.

Variables it adds

Variable	What it holds
%isPinned%	True if a message is pinned
%pinnedMessage%	The text of the pinned message
%pinnedMessageId%	The id of the pinned message
%pinnedUser%	Who wrote the pinned message
%pinnedUserName%	Their login name
%pinnedBy%	Who pinned it
%pinnedUntil%	When the pin ends (empty if it stays until the stream ends)

Type id: twitch.getPinnedMessage

Get shield mode status

Checks whether shield mode is on and saves the answer for the next steps.

Variables it adds

Variable	What it holds
%shieldModeActive%	True if shield mode is on
%shieldModeModerator%	Who last changed it

Type id: twitch.getShieldMode

Get stream info (isLive, viewerCount, streamTitle, uptimeSeconds...)

Checks whether a channel is live and saves the viewer count, title and uptime for the next steps.

Setting	What to put in
Channel	The channel to check: a login name like "coolstreamer" or id:12345. Leave empty for your own channel.

Variables it adds

Variable	What it holds
%isLive%	True if the channel is live
%viewerCount%	How many people are watching (0 when offline)
%streamTitle%	The stream title
%streamGame%	The category (game) name
%streamStartedAt%	When the stream started
%uptimeSeconds%	How many seconds the stream has been live

Type id: twitch.getStreamInfo

Get sub counter (subCounter.count, subCounter.rollover, subCounter.rolloverCount)

Reads Cuebot's own sub counter (for a sub goal) and saves its numbers for the next steps.

Variables it adds

Variable	What it holds
%subCounter.count%	Subs counted so far in this round
%subCounter.rollover%	The count at which the counter starts over (0 = never)
%subCounter.rolloverCount%	How many times it already started over

Type id: twitch.getSubCounter

Get subscriber count

Looks up how many subscribers you have and saves the numbers for the next steps.

Variables it adds

Variable	What it holds
%subscriberCount%	Your number of subscribers
%subPoints%	Your sub points (higher tiers count for more)

Type id: twitch.getSubscriberCount

Get subscription status

Checks if a viewer subscribes to you and saves the answer for the next steps.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%isSubscribed%	True if they subscribe
%subTier%	Their tier (empty if not subscribed)
%subIsGift%	True if their sub was a gift
%subGifter%	Who gifted it

Type id: twitch.getSubStatus

Get team info (teams, teamCount)

Looks up which Twitch teams a user belongs to and saves them for the next steps.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%teams%	The team names, separated by commas
%teamCount%	How many teams they are in
%teamName%	The name of their first team

Type id: twitch.getTeamInfo

Get user info (targetUser, targetUserId, targetDescription, targetCreatedAt...)

Looks up a Twitch user and saves their name, account age, subscriber status and more for the next steps.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%targetFound%	True if the user exists
%targetUser%	Their display name
%targetUserName%	Their login name
%targetUserId%	Their Twitch id
%targetDescription%	Their profile text
%targetCreatedAt%	When their account was made
%targetAccountAgeDays%	How many days old their account is
%targetIsSubscribed%	True if they subscribe to you
%targetIsModerator%	True if they moderate your channel
%targetIsVip%	True if they are a VIP
%targetGame%	The category they last streamed
%targetProfileImageUrl%	The web link of their profile picture

Type id: twitch.getUserInfo

Guest Star: assign slot

Puts a Guest Star guest into a slot so they appear on screen.

Setting	What to put in
Guest	Which guest: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Slot	The slot number, starting at 1. A slot is one guest spot on screen. Starts as: 1.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.assignGuestStarSlot

Guest Star: create session

Starts a new Guest Star session so guests can join.

Variables it adds

Variable	What it holds
%guestStarSessionId%	The new session's id
%guestStarActive%	True when a session exists

Type id: twitch.createGuestStarSession

Guest Star: delete invite

Takes back a Guest Star invite.

Setting	What to put in
Guest	Whose invite to take back: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.deleteGuestStarInvite

Guest Star: end session

Ends the Guest Star session.

Setting	What to put in
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.endGuestStarSession

Guest Star: get channel settings (guestStarSlotCount, guestStarLayout...)

Looks up your Guest Star settings and saves them for the next steps. Guest Star lets guests join your stream.

Variables it adds

Variable	What it holds
%guestStarSlotCount%	How many guest slots there are
%guestStarLayout%	The layout in use
%guestStarModeratorSendLive%	True if moderators may send guests live
%guestStarBrowserSourceAudio%	True if browser source audio is on

Type id: twitch.getGuestStarSettings

Guest Star: get invites (guestStarInviteCount, guestStarInvite0UserId, ...Status)

Looks up who you invited to Guest Star and saves it for the next steps.

Setting	What to put in
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Variables it adds

Variable	What it holds
%guestStarInviteCount%	How many invites there are
%guestStarInvites%	The ids of the invited people, separated by commas
%guestStarInvite0UserId%	The first invited person's id. Use 1, 2, ... for the next ones
%guestStarInvite0Status%	Whether they accepted, like INVITED or ACCEPTED

Type id: twitch.getGuestStarInvites

Guest Star: get session (guestStarSessionId, guestStarGuestCount, guestStarGuest0..)

Looks up the Guest Star session that is running and its guests, and saves them for the next steps.

Variables it adds

Variable	What it holds
%guestStarActive%	True if a session is running
%guestStarSessionId%	The session's id
%guestStarGuestCount%	How many guests are in it
%guestStarGuest0%	The first guest's display name. Use 1, 2, ... for the next ones
%guestStarGuest0UserName%	Their login name
%guestStarGuest0Slot%	Their slot
%guestStarGuest0IsLive%	True if they are live on stream

Type id: twitch.getGuestStarSession

Guest Star: move guest to another slot

Moves a Guest Star guest from one slot to another.

Setting	What to put in
From slot	The slot the guest is in now, starting at 1. Starts as: 1.
To slot	The slot to move them to, starting at 1. Starts as: 1.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.updateGuestStarSlot

Guest Star: remove guest from slot

Takes a guest out of their slot.

Setting	What to put in
Guest	Which guest: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Slot	The slot number, starting at 1. A slot is one guest spot on screen. Starts as: 1.
Send back to the invite queue	Tick to put the guest back into the invite queue. Untick to just remove them. Starts as: false.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.deleteGuestStarSlot

Guest Star: send invite

Invites a viewer to join your Guest Star session.

Setting	What to put in
Guest	Who to invite: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.sendGuestStarInvite

Guest Star: update channel settings

Changes your Guest Star settings, like the number of slots and the layout. Anything set to Keep stays as it is.

Setting	What to put in
Slots (1 to 6, 0 = keep)	How many guest slots, from 1 to 6. 0 keeps the current number. Starts as: 0.
Layout	How guests are arranged on screen. Keep leaves it as it is. Options: Keep as it is, Tiled, Screen share, Side by side, Stacked. Starts as: Keep as it is.
Moderators can send guests live	Whether moderators may send guests live. Keep leaves it as it is. On or Off changes it. Options: Keep, On, Off. Starts as: Keep.
Browser source audio	Whether the browser source plays guest audio. Keep leaves it as it is. On or Off changes it. Options: Keep, On, Off. Starts as: Keep.
Regenerate browser sources (invalidates the old ones)	Tick to make new browser source links. The old links stop working, so update them in your streaming software. Starts as: false.

Type id: twitch.updateGuestStarSettings

Guest Star: update slot settings

Changes the sound, picture, live state or volume of one guest slot. Anything set to Keep stays as it is.

Setting	What to put in
Slot	The slot number, starting at 1. A slot is one guest spot on screen. Starts as: 1.
Audio	The guest's microphone. Keep leaves it as it is. On or Off changes it. Options: Keep, On, Off. Starts as: Keep.
Video	The guest's camera. Keep leaves it as it is. On or Off changes it. Options: Keep, On, Off. Starts as: Keep.
Live	Whether the guest is shown on your stream. Keep leaves it as it is. On or Off changes it. Options: Keep, On, Off. Starts as: Keep.
Volume (0 to 100, -1 = keep)	The guest's volume from 0 to 100. -1 keeps the current volume. Starts as: -1.
Session id	Leave empty to use the Guest Star session that is running now. Most people leave this alone.

Type id: twitch.updateGuestStarSlotSettings

Lock active prediction (locked, prediction.*)

Closes the betting on the running prediction, so nobody can bet any more.

Variables it adds

Variable	What it holds
%locked%	True when betting was closed
%prediction.Title%	The question

Type id: twitch.lockPrediction

Pick random viewers from chat

Picks one or more random people from the people in chat right now and saves their names for the next steps.

Setting	What to put in
How many	How many people to pick (at least 1). Starts as: 1.
Leave out the broadcaster and the bot	Tick to leave out you and your bot account when picking. Starts as: true.

Variables it adds

Variable	What it holds
%randomUserCount%	How many people were picked
%randomUser0%	The first person's display name. Use 1, 2, ... for the next ones
%randomUserName0%	Their login name
%randomUserId0%	Their Twitch id

Type id: twitch.getRandomUsers

Pin chat message

Pins a chat message to the top of your chat so everyone can see it.

Setting	What to put in
Message id	The id of the chat message. The default %messageId% is the message that started the action. Starts as: %messageId%.
Pinned for (seconds)	How long it stays pinned, in seconds (30 to 1800). 0 keeps it pinned until the stream ends. Starts as: 0.

Type id: twitch.pinMessage

Remove channel tag

Removes one tag from your stream tags and keeps the others.

Setting	What to put in
Tag	The tag to remove, like "Cozy". Capital letters and a leading # do not matter.

Type id: twitch.removeTag

Remove moderator

Takes the moderator job away from a viewer.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Type id: twitch.removeModerator

Remove suspicious status

Removes the suspicious mark from a viewer.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%suspiciousUser%	The display name of the person
%suspiciousUserId%	Their Twitch id
%suspiciousStatusResult%	True when it worked

Type id: twitch.removeSuspiciousStatus

Remove timeout

Ends a timeout early so the viewer can chat again.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%unTimedOutUser%	The display name of the person whose timeout ended
%unTimedOutUserName%	Their login name
%unTimedOutUserId%	Their Twitch id
%unTimedOutResult%	True when it worked

Type id: twitch.untimeout

Remove VIP

Takes the VIP badge away from a viewer.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Type id: twitch.removeVip

Reply to message

Answers a chat message so it shows as a reply to that message. Great for command answers.

Setting	What to put in
Message	What to write back. You can use %variables%, like Hi %user%! If it is empty nothing is sent.
Reply to message id	The id of the message to reply to. The default %messageId% is the message that started the action. Starts as: %messageId%.
Send as	Which account writes it. Default uses your bot account if it is signed in (see the Twitch page), otherwise your own account. Or pick Bot or Broadcaster. Options: Default, Bot, Broadcaster. Starts as: Default.

Type id: twitch.replyToMessage

Resolve prediction (success, prediction., prediction.winningOutcome.)

Picks the winning result of a prediction and pays out the winners.

Setting	What to put in
Winning outcome	The winning result: its text like "Yes", or its number (1 for the first, 2 for the second, ...).
Only if the prediction is titled	Only act if the open prediction has exactly this question. Leave empty to use the latest open prediction.

Variables it adds

Variable	What it holds
%success%	True when it was resolved
%prediction.Title%	The question
%prediction.winningOutcome.title%	The text of the winning result

Type id: twitch.resolvePrediction

Reward group: set enabled state

Turns every reward in a group on or off at once. Only rewards that Cuebot created can be changed.

Setting	What to put in
Reward group	The group name, like "Sound alerts". You give rewards a group on the Twitch page (Rewards tab).
State	Enabled shows the rewards. Disabled hides them. Toggle turns them on, unless one is already on, then it turns them off. Options: Enabled, Disabled, Toggle. Starts as: Enabled.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many rewards could not be changed

Type id: twitch.setRewardGroupEnabled

Reward group: set paused state

Pauses or resumes every reward in a group at once. Only rewards that Cuebot created can be changed.

Setting	What to put in
Reward group	The group name, like "Sound alerts". You give rewards a group on the Twitch page (Rewards tab).
State	Paused pauses the rewards. Unpaused lets viewers redeem them. Toggle pauses them, unless one is already paused, then it resumes them. Options: Paused, Unpaused, Toggle. Starts as: Paused.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many rewards could not be changed

Type id: twitch.setRewardGroupPaused

Reward: delete

Deletes a channel points reward for good.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.

Type id: twitch.deleteReward

Reward: fulfil or cancel redemption

Marks a redeemed reward as done (fulfil) or turns it down (cancel). Cancel gives the points back.

Setting	What to put in
Reward id	The id of the reward. The default %rewardId% is the reward that started the action. Starts as: %rewardId%.
Redemption id	The id of this redemption. The default %redemptionId% is the one that started the action. Starts as: %redemptionId%.
Status	Fulfil marks it as done. Cancel refunds the viewer's channel points. Options: Fulfil, Cancel. Starts as: Fulfil.

Type id: twitch.updateRedemption

Reward: get counters (counter, userCounter)

Looks up how often a reward was redeemed, in total and by one viewer, and saves the numbers.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
For user	The viewer to count for: a login name like "coolviewer" or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%counter%	How many times the reward was redeemed
%userCounter%	How many times that viewer redeemed it

Type id: twitch.getRewardCounter

Reward: get info (rewardTitle, rewardCost, rewardEnabled, rewardPaused...)

Looks up a channel points reward and saves its title, cost and settings for the next steps.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.

Variables it adds

Variable	What it holds
%rewardId%	Twitch's id for the reward
%rewardTitle%	The reward's name
%rewardPrompt%	The description text
%rewardCost%	The price in channel points
%rewardEnabled%	True if the reward is on
%rewardPaused%	True if the reward is paused
%rewardCooldown%	The wait time in seconds (0 = none)
%rewardMaxPerStream%	The limit per stream (0 = none)
%rewardMaxPerUser%	The limit per viewer (0 = none)
%rewardBackgroundColor%	The colour code

Type id: twitch.getRewardInfo

Reward: reset counter

Sets a reward's redeem counter back to 0.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.

Type id: twitch.resetRewardCounter

Reward: reset user counters

Sets every viewer's personal redeem counter for a reward back to 0.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.

Type id: twitch.resetRewardUserCounters

Reward: set background colour

Changes the background colour of a channel points reward.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Colour (#RRGGBB)	The colour as a code like #9147FF (purple). Search for a "colour picker" to find codes. Starts as: #9147FF.
Random colour	Tick to pick a random colour each time. The colour code is then ignored. Starts as: false.

Type id: twitch.setRewardColor

Reward: set cost

Changes how many channel points a reward costs.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Cost	The new price in channel points. Starts as: 100.

Type id: twitch.setRewardCost

Reward: set enabled

Turns a channel points reward on or off. A reward that is off is hidden from viewers.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Enabled	Tick to show the reward, untick to hide it. Starts as: true.

Type id: twitch.setRewardEnabled

Reward: set global cooldown

Sets how long everyone must wait before the reward can be redeemed again.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Cooldown (seconds)	The wait time in seconds. 0 turns the cooldown off. Starts as: 0.

Type id: twitch.setRewardCooldown

Reward: set max per stream

Limits how many times a reward can be redeemed in one stream, by everybody together.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Maximum	The most redemptions per stream. 0 turns the limit off. Starts as: 0.
Additive	Tick to add this number to the current limit instead of replacing it. Use a negative number to lower it. Starts as: false.

Type id: twitch.setRewardMaxPerStream

Reward: set max per user per stream

Limits how many times each viewer can redeem a reward in one stream.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Maximum	The most redemptions per viewer per stream. 0 turns the limit off. Starts as: 0.
Additive	Tick to add this number to the current limit instead of replacing it. Use a negative number to lower it. Starts as: false.

Type id: twitch.setRewardMaxPerUser

Reward: set paused

Pauses or resumes a channel points reward. A paused reward is still shown but cannot be redeemed.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Paused	Tick to pause the reward, untick to let viewers redeem it again. Starts as: true.

Type id: twitch.setRewardPaused

Reward: set prompt

Changes the description text viewers see on a channel points reward.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Prompt	The new description text.

Type id: twitch.setRewardPrompt

Reward: set title

Changes the name of a channel points reward.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Title	The new name of the reward.

Type id: twitch.setRewardTitle

Reward: update title, prompt and cost

Changes the name, description and price of a reward in one go. Anything you leave empty stays as it is.

Setting	What to put in
Reward	The reward's name exactly as on Twitch, like "Hydrate", or its id. Leave empty to use the reward that was just redeemed.
Title	The new name. Leave empty to keep the current one.
Prompt	The new description text. Leave empty to keep the current one.
Cost	A number. Leave empty to keep the price. What it does depends on the operator below.
Cost operator	How to use the cost number. Set makes it the new price. Add, Subtract, Multiply and Divide change the current price. The price never goes below 1. Options: Set, Add, Subtract, Multiply, Divide. Starts as: Set.

Variables it adds

Variable	What it holds
%rewardCost%	The reward's price after the change

Type id: twitch.updateReward

Run commercial

Starts a commercial break on your channel. Only works while you are live and are an affiliate or partner.

Setting	What to put in
Length (seconds)	How long the ad break runs, in seconds. Options: 30 seconds, 1 minute, 1½ minutes, 2 minutes, 2½ minutes, 3 minutes. Starts as: 30 seconds.

Variables it adds

Variable	What it holds
%adLength%	How long the ad break is, in seconds
%adRetryAfter%	How many seconds until you can run another ad

Type id: twitch.runAd

Send announcement

Posts a highlighted announcement in your Twitch chat, which stands out from normal messages.

Setting	What to put in
Message	The announcement text. You can use %variables%.
Colour	The colour of the highlight bar. Primary uses your channel's own accent colour. Options: primary, blue, green, orange, purple. Starts as: primary.

Type id: twitch.sendAnnouncement

Send chat message

Sends a message in your Twitch chat. Handy for replies, thank-yous and reminders.

Setting	What to put in
Message	What to write in chat. You can use %variables%, like Thanks %user%! If it is empty nothing is sent.
Send as	Which account writes it. Default uses your bot account if it is signed in (see the Twitch page), otherwise your own account. Or pick Bot or Broadcaster. Options: Default, Bot, Broadcaster. Starts as: Default.

Type id: twitch.sendMessage

Send shoutout

Gives another channel an official Twitch shoutout, which shows them off to your viewers.

Setting	What to put in
Channel	The channel to shout out: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%shoutoutSuccess%	True when the shoutout was sent

Type id: twitch.sendShoutout

Send whisper

Sends a private message (whisper) to one viewer. The account that sends it needs a verified phone number on Twitch.

Setting	What to put in
To user	Who gets the whisper: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Message	What to whisper. You can use %variables%. If it is empty nothing is sent.
Send as	Which account writes it. Default uses your bot account if it is signed in (see the Twitch page), otherwise your own account. Or pick Bot or Broadcaster. Options: Default, Bot, Broadcaster. Starts as: Default.

Type id: twitch.sendWhisper

Set branded content (success)

Turns the "branded content" label on your stream on or off. Use it when a sponsor is paying you.

Setting	What to put in
Branded content	Tick to mark the stream as branded content, untick to remove the label. Starts as: true.

Variables it adds

Variable	What it holds
%success%	True when the setting was changed

Type id: twitch.setBrandedContent

Set channel category

Changes your stream category (the game) on Twitch. It fails if Twitch finds no matching category.

Setting	What to put in
Category / game name	The category name, like "Just Chatting". Twitch picks the closest match.

Variables it adds

Variable	What it holds
%gameName%	The category that was set
%gameId%	Twitch's id for that category
%gameBoxArt%	The web link of the category's cover picture
%gameSuccess%	True when the category was changed

Type id: twitch.setGame

Set channel tags

Replaces all of your stream tags with the ones you list.

Setting	What to put in
Tags	The new tags, like "English, Chill, Cozy". Separate with commas or spaces, at most 10. All old tags are replaced.

Type id: twitch.setTags

Set channel title

Changes your stream title on Twitch.

Setting	What to put in
Title	The new title, like "Chill games with chat". You can use %variables%.

Variables it adds

Variable	What it holds
%titleSuccess%	True when the title was changed

Type id: twitch.setTitle

Set content classification label

Turns one content warning label (like gambling or violence) on or off for your channel.

Setting	What to put in
Label	Which content warning to change. Options: Drugs, smoking or alcohol, Sexual themes, Violent and graphic content, Gambling, Strong language. Starts as: Strong language.
Enabled	Tick to add the label to your channel, untick to remove it. Starts as: true.

Type id: twitch.setContentLabel

Set shield mode

Turns Twitch's shield mode on or off. Shield mode applies your pre-set strict chat rules during a flood of trolls.

Setting	What to put in
Active	Tick to turn shield mode on, untick to turn it off. Starts as: true.

Type id: twitch.setShieldMode

Set sub counter

Sets Cuebot's own sub counter to a number you choose, for example to fix it or start a new goal.

Setting	What to put in
Count	The new count. A whole number, 0 or more. Starts as: 0.
Rollover count	How many times the counter has started over. Leave empty to keep the current number.

Variables it adds

Variable	What it holds
%setResult%	True when the counter was changed
%subCounter.count%	The new count

Type id: twitch.setSubCounter

Snooze next ad (snoozeCount, nextAdAt, snooze.success)

Pushes your next automatic ad back a little. Twitch only allows a few snoozes.

Variables it adds

Variable	What it holds
%snoozeCount%	How many snoozes you have left
%nextAdAt%	When the next ad starts
%snooze.success%	True when the ad was snoozed

Type id: twitch.snoozeAd

Start raid

Sends your viewers to another channel (a raid). Twitch starts it after a short countdown.

Setting	What to put in
Channel to raid	The channel to raid: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%startRaidSuccess%	True when the raid was started

Type id: twitch.startRaid

Timeout user

Stops a viewer from chatting for a while (a timeout).

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Duration (seconds)	How long the timeout lasts, in seconds. From 1 second up to 14 days (1209600). 600 is ten minutes. Starts as: 600.
Reason	Why they are timed out. Can be empty.

Variables it adds

Variable	What it holds
%timedOutUser%	The display name of the person who was timed out
%timedOutUserName%	Their login name
%timedOutUserId%	Their Twitch id
%timeoutResult%	True when the timeout worked

Type id: twitch.timeout

Unban user

Lifts a ban so the viewer can chat again.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.

Variables it adds

Variable	What it holds
%unbannedUser%	The display name of the person who was unbanned
%unbannedUserName%	Their login name
%unbannedUserId%	Their Twitch id
%unbanResult%	True when the unban worked

Type id: twitch.unban

Unpin chat message

Removes the pin from a pinned chat message.

Setting	What to put in
Pinned message id	The id of the pinned message. Leave empty to unpin the message that is pinned now.

Type id: twitch.unpinMessage

Update pinned message duration

Changes how much longer a pinned chat message stays pinned.

Setting	What to put in
Pinned message id	The id of the pinned message. Leave empty to use the message that is pinned now.
Pinned for (seconds, from now)	How long it stays pinned from now, in seconds (30 to 1800). 0 keeps it pinned until the stream ends. Starts as: 60.

Type id: twitch.updatePinnedDuration

Update stream info

Changes the title, the category and the tags in one go. Anything you leave empty stays as it is.

Setting	What to put in
Title	The new title. Leave empty to keep the current one.
Category / game	The new category, like "Just Chatting". Leave empty to keep the current one.
Tags	New tags separated by commas, like "English, Chill". Leave empty to keep the current tags.

Type id: twitch.updateStreamInfo

Warn user

Sends a warning to a viewer. They must accept it before they can chat again.

Setting	What to put in
User	Who to pick: a Twitch login name like "coolviewer" (a leading @ is fine) or id:12345. Leave empty to use the person who triggered the action.
Reason	What you warn them about, like "Please be kind". They see this text.

Variables it adds

Variable	What it holds
%warnedUser%	The display name of the person who was warned
%warnedUserName%	Their login name
%warnedUserId%	Their Twitch id
%warnedResult%	True when the warning was sent

Type id: twitch.warn