YouTube triggers¶

API quota exhausted¶

Runs when Cuebot has used up your daily YouTube limit (quota). YouTube then blocks most requests until the limit resets.

Variables you get

Variable	What it holds
`%resumesAt%`	When YouTube lets Cuebot continue
`%quotaUsed%`	How much of the limit was used today

Type id: youtube.quotaExceeded

Broadcast added (scheduled)¶

Runs when you schedule a new YouTube live stream. Cuebot notices it a few minutes later.

Variables you get

Variable	What it holds
`%broadcastTitle%`	The stream title
`%broadcastId%`	ID of the stream
`%broadcastScheduledStart%`	When it is planned to start
`%broadcastUrl%`	Web link to the stream

Type id: youtube.broadcastAdded

Broadcast ended¶

Runs when your YouTube live stream ends. Handy for a goodbye message.

Variables you get

Variable	What it holds
`%broadcastTitle%`	Your stream title
`%broadcastId%`	ID of the stream
`%broadcastActualEnd%`	When it ended

Type id: youtube.broadcastEnded

Broadcast removed¶

Runs when a scheduled YouTube live stream is deleted or cancelled before it started.

Variables you get

Variable	What it holds
`%broadcastTitle%`	The stream title
`%broadcastId%`	ID of the stream

Type id: youtube.broadcastRemoved

Broadcast started¶

Runs when your YouTube live stream goes live. Use it to say hello, switch scenes or reset counters.

Variables you get

Variable	What it holds
`%broadcastTitle%`	Your stream title
`%broadcastId%`	ID of the stream
`%broadcastUrl%`	Web link to the stream
`%broadcastActualStart%`	When it went live

Type id: youtube.broadcastStarted

Broadcast statistics updated¶

Runs each time Cuebot reads the numbers of your live YouTube stream (about once a minute). Use it to react to viewer counts.

Setting	What to put in
Minimum concurrent viewers	Only run when at least this many people watch right now. 0 runs every time. Example: 100. Starts as: `0`.

Variables you get

Variable	What it holds
`%concurrentViewers%`	How many people watch right now
`%viewCount%`	Total views
`%likeCount%`	Likes
`%commentCount%`	Comments
`%broadcastTitle%`	The stream title

Type id: youtube.broadcastStatisticsUpdated

Broadcast updated¶

Runs when the title, description or privacy of your YouTube stream changes.

Variables you get

Variable	What it holds
`%broadcastTitle%`	The new title
`%previousTitle%`	The title before
`%broadcastDescription%`	The new description
`%broadcastPrivacy%`	public, unlisted or private
`%previousPrivacy%`	The privacy before

Type id: youtube.broadcastUpdated

Chat message¶

Runs when someone writes in your YouTube live chat. Handy for replies or word triggers.

Setting	What to put in
Message contains	Only run when the message has this text in it, like "hello". Capital letters do not matter. Leave empty to run for every message.
Ignore the bot account	Tick to skip messages written by your own bot account, so it does not react to itself. Starts as: `true`.

Variables you get

Variable	What it holds
`%user%`	Name of the person who wrote
`%userId%`	Their YouTube channel ID
`%message%`	What they wrote
`%messageId%`	ID of the message
`%isModerator%`	True if they are a moderator
`%isMember%`	True if they are a channel member
`%isBroadcaster%`	True if it is you

Type id: youtube.chatMessage

Gift membership received¶

Runs for each person who receives a gifted membership. Good for welcoming the new member.

Setting	What to put in
Membership level contains	Only run for membership levels whose name has this text in it, like "Gold". Empty runs for every level.

Variables you get

Variable	What it holds
`%user%`	Name of the person who received it
`%userId%`	Their YouTube channel ID
`%gifterName%`	Name of the person who gifted it
`%levelName%`	Name of the membership level

Type id: youtube.giftMembershipReceived

Jewels gifted¶

Runs when a viewer sends Jewels (YouTube's gifts for vertical live streams).

Setting	What to put in
Minimum jewels	Only run when at least this many Jewels were sent. 0 runs for every gift. Example: 50. Starts as: `0`.

Variables you get

Variable	What it holds
`%user%`	Name of the sender
`%jewels%`	How many Jewels
`%giftName%`	Name of the gift
`%comboCount%`	How many times in a row (a combo)
`%message%`	The text that came with it

Type id: youtube.jewelsGifted

Member milestone¶

Runs when a member shares their milestone message, for example "12 months" of membership. Good for a thank-you.

Setting	What to put in
Membership level contains	Only run for membership levels whose name has this text in it, like "Gold". Empty runs for every level.
Minimum months	Only run when the member has been with you at least this many months. 0 runs for every milestone. Example: 6. Starts as: `0`.

Variables you get

Variable	What it holds
`%user%`	Name of the member
`%months%`	How many months they have been a member
`%levelName%`	Name of the membership level
`%message%`	The message they wrote with it

Type id: youtube.memberMilestone

Members-only mode ended¶

Runs when members-only chat is turned off, so everyone can write again.

Variables you get

Variable	What it holds
`%moderator%`	Who turned it off

Type id: youtube.sponsorOnlyEnded

Members-only mode started¶

Runs when members-only chat is turned on, so only your channel members can write.

Variables you get

Variable	What it holds
`%moderator%`	Who turned it on

Type id: youtube.sponsorOnlyStarted

Membership gift¶

Runs when someone buys memberships as gifts for others. It runs once for the gifter. Use it to thank them for the whole gift.

Setting	What to put in
Membership level contains	Only run for membership levels whose name has this text in it, like "Gold". Empty runs for every level.
Minimum gifted	Only run when at least this many memberships were gifted. Example: 5. Starts as: `1`.

Variables you get

Variable	What it holds
`%user%`	Name of the gifter
`%userId%`	Their YouTube channel ID
`%total%`	How many memberships were gifted
`%levelName%`	Name of the membership level

Type id: youtube.membershipGift

Message deleted¶

Runs when a message is deleted from your YouTube live chat.

Variables you get

Variable	What it holds
`%messageId%`	ID of the deleted message
`%targetUser%`	Name of the person who wrote it, if Cuebot saw it
`%targetMessage%`	What it said, if Cuebot saw it
`%moderator%`	Who deleted it

Type id: youtube.messageDeleted

New channel member¶

Runs when someone becomes a new member of your YouTube channel (YouTube calls members "sponsors"). Good for a thank-you.

Setting	What to put in
Membership level contains	Only run for membership levels whose name has this text in it, like "Gold". Empty runs for every level.
Upgrades	"Only upgrades" runs only when a member moves up to a higher level. "No upgrades" runs only for brand-new members. "Any" runs for both. Options: Any, Only upgrades, No upgrades. Starts as: `Any`.

Variables you get

Variable	What it holds
`%user%`	Name of the new member
`%userId%`	Their YouTube channel ID
`%levelName%`	Name of the membership level
`%isUpgrade%`	True if they upgraded from a lower level
`%message%`	YouTube's message about it

Type id: youtube.newSponsor

New subscriber¶

Runs when someone subscribes to your YouTube channel. Cuebot checks every few minutes and can only see people whose subscriptions are public.

Variables you get

Variable	What it holds
`%user%`	Name of the new subscriber
`%userId%`	Their YouTube channel ID
`%channelUrl%`	Web link to their channel
`%subscribedAt%`	When they subscribed

Type id: youtube.newSubscriber

Poll closed¶

Runs when a poll in your YouTube live chat ends. Use it to announce the winner.

Variables you get

Variable	What it holds
`%pollTitle%`	The poll question
`%pollTotalVotes%`	All votes
`%pollWinningChoice%`	Text of the winning option
`%pollWinningVotes%`	Votes of the winning option
`%pollChoice0Title%`	Text of the first option (then pollChoice1Title...)

Type id: youtube.pollClosed

Poll started¶

Runs when a poll starts in your YouTube live chat.

Variables you get

Variable	What it holds
`%pollTitle%`	The poll question
`%pollChoice0Title%`	Text of the first option (then pollChoice1Title...)
`%pollChoiceCount%`	How many options
`%pollMessageId%`	ID of the poll

Type id: youtube.pollStarted

Poll updated¶

Runs when the votes in your YouTube chat poll change.

Variables you get

Variable	What it holds
`%pollTitle%`	The poll question
`%pollChoice0Votes%`	Votes for the first option (then pollChoice1Votes...)
`%pollTotalVotes%`	All votes so far
`%pollMessageId%`	ID of the poll

Type id: youtube.pollUpdated

Started watching a stream's chat¶

Runs when Cuebot starts watching a YouTube stream's chat (it finds a live stream, or you connect during one). It is not the same as going live.

Variables you get

Variable	What it holds
`%broadcastTitle%`	The stream title
`%broadcastId%`	ID of the stream

Type id: youtube.broadcastMonitoringStarted

Stopped watching a stream's chat¶

Runs when Cuebot stops watching a YouTube stream's chat, because it ended or you disconnected.

Variables you get

Variable	What it holds
`%broadcastTitle%`	The stream title
`%broadcastId%`	ID of the stream

Type id: youtube.broadcastMonitoringEnded

Super Chat¶

Runs when a viewer pays for a Super Chat (a highlighted paid message). Good for a thank-you or an alert.

Setting	What to put in
Minimum amount	Only run for at least this much money, in the currency the viewer paid in. 0 means no minimum. Example: 5. Starts as: `0`.
Maximum amount (0 = no limit)	Only run for at most this much money. 0 means no maximum. Starts as: `0`.
Currency (ISO code, empty = any)	Only run for this currency, as a 3-letter code like "USD" or "EUR". Empty runs for any currency.
Minimum tier	Only run for this level or higher. YouTube gives each Super Chat a color level from 1 (lowest) up. 0 runs for every level. Starts as: `0`.

Variables you get

Variable	What it holds
`%user%`	Name of the sender
`%amount%`	How much was paid, as a number
`%currency%`	Currency code, like USD
`%amountText%`	The amount as YouTube shows it, like $5.00
`%tier%`	The Super Chat color level
`%message%`	The text that came with it

Type id: youtube.superChat

Super Sticker¶

Runs when a viewer pays for a Super Sticker (a paid picture in chat). Good for a thank-you or an alert.

Setting	What to put in
Minimum amount	Only run for at least this much money, in the currency the viewer paid in. 0 means no minimum. Example: 2. Starts as: `0`.
Maximum amount (0 = no limit)	Only run for at most this much money. 0 means no maximum. Starts as: `0`.
Currency (ISO code, empty = any)	Only run for this currency, as a 3-letter code like "USD" or "EUR". Empty runs for any currency.
Minimum tier	Only run for this level or higher. YouTube gives each Super Sticker a color level from 1 (lowest) up. 0 runs for every level. Starts as: `0`.

Variables you get

Variable	What it holds
`%user%`	Name of the sender
`%amount%`	How much was paid, as a number
`%currency%`	Currency code, like USD
`%amountText%`	The amount as YouTube shows it
`%tier%`	The color level
`%stickerAltText%`	A text describing the sticker

Type id: youtube.superSticker

User banned¶

Runs when someone is banned from your YouTube live chat.

Variables you get

Variable	What it holds
`%user%`	Name of the banned person
`%userId%`	Their YouTube channel ID
`%moderator%`	Who banned them
`%banType%`	permanent or temporary

Type id: youtube.userBanned

User timed out¶

Runs when someone gets a timeout (a short mute) in your YouTube live chat.

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

Variables you get

Variable	What it holds
`%user%`	Name of the person
`%userId%`	Their YouTube channel ID
`%moderator%`	Who gave the timeout
`%duration%`	Length of the timeout in seconds

Type id: youtube.userTimedOut