YouTube sub-actions¶

Add broadcaster information¶

Saves details about your YouTube account and your bot account as variables for the next steps. It has no settings.

Variables it adds

Variable	What it holds
`%broadcastUser%`	Your channel name
`%broadcastUserId%`	Your channel ID
`%broadcastCustomUrl%`	Your channel's @handle
`%botUser%`	Your bot account's channel name
`%botIsSignedIn%`	True if the bot account is signed in

Type id: youtube.addBroadcasterInfo

Add moderator¶

Makes someone a moderator of your YouTube live chat. Needs a live stream.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.addModerator

Ban user¶

Bans someone from your YouTube live chat for good. Needs a live stream.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Variables it adds

Variable	What it holds
`%bannedUser%`	Name of the banned person
`%bannedUserId%`	Their YouTube channel ID
`%banResult%`	True when it worked

Type id: youtube.banUser

Create poll¶

Starts a poll in your YouTube live chat. Viewers vote right in the chat. Needs a live stream.

Setting	What to put in
Question	The poll question, like "Which game next?".
Options (one per line, 2–4)	The answers, one per line. You need 2 to 4.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Variables it adds

Variable	What it holds
`%pollMessageId%`	ID of the poll, to end it later

Type id: youtube.createPoll

Delete message¶

Deletes one message from your YouTube live chat.

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

Type id: youtube.deleteMessage

End poll¶

Ends a poll in your YouTube live chat.

Setting	What to put in
Poll message id	ID of the poll to end. Leave empty to end the poll Cuebot started most recently.

Type id: youtube.endPoll

Get latest monitored broadcast¶

Finds your latest YouTube live stream and saves its details as variables for the next steps. It has no settings.

Variables it adds

Variable	What it holds
`%broadcastIsLive%`	True if a live stream was found
`%broadcastTitle%`	Its title
`%broadcastId%`	Its ID
`%broadcastUrl%`	Web link to it
`%concurrentViewers%`	People watching right now
`%likeCount%`	Likes
`%viewCount%`	Views

Type id: youtube.getBroadcast

Get user (channel) info¶

Looks up a YouTube channel and saves its details as variables for the next steps. Handy for a shout-out command.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.

Variables it adds

Variable	What it holds
`%channelTitle%`	Channel name
`%channelUrl%`	Web link to the channel
`%channelDescription%`	Its description
`%channelSubscriberCount%`	Subscribers
`%channelVideoCount%`	Videos
`%channelViewCount%`	Total views
`%channelProfileImageUrl%`	Web link to its picture

Type id: youtube.getChannelInfo

Get video info¶

Looks up a YouTube video or stream and saves its details as variables for the next steps.

Setting	What to put in
Video id	The ID of the video (the part after v= in its web link). Leave empty to use your latest live stream.

Variables it adds

Variable	What it holds
`%videoTitle%`	Its title
`%videoDescription%`	Its description
`%videoUrl%`	Web link to it
`%videoViewCount%`	Views
`%videoLikeCount%`	Likes
`%videoConcurrentViewers%`	People watching right now (live only)
`%videoPrivacy%`	public, unlisted or private

Type id: youtube.getVideoInfo

Remove moderator¶

Takes away someone's moderator role in your YouTube live chat. Needs a live stream.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.removeModerator

Send message to channel¶

Writes a message in your YouTube live chat. You can use variables like %user% in the text.

Setting	What to put in
Message	What to write, like "Thanks for watching, %user%!". Messages over 200 letters are cut into several messages.
Send as the bot account	Tick to write as your bot account instead of your own account. The bot must be signed in. Starts as: `false`.
Fall back to the broadcaster	Tick to write as you if the bot account is not signed in or fails. Untick to get an error instead. Starts as: `true`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.sendMessage

Set category¶

Changes the category of your YouTube stream (the kind of video, like Gaming).

Setting	What to put in
Category number	YouTube's category number. Examples: 20 for Gaming, 22 for People & Blogs, 10 for Music.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.setCategory

Set description¶

Changes the description text of your YouTube live stream.

Setting	What to put in
Description	The new description text. It can have several lines.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.setDescription

Set privacy¶

Changes who can see your YouTube stream.

Setting	What to put in
Privacy	"public" = everyone can find it. "unlisted" = only people with the link. "private" = only you. Options: public, unlisted, private. Starts as: `public`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.setPrivacy

Set title¶

Changes the title of your YouTube live stream.

Setting	What to put in
Title	The new title, like "Playing with viewers!". It cannot be empty.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.setTitle

Set title and description¶

Changes the title and the description of your YouTube live stream in one step.

Setting	What to put in
Title	The new title, like "Playing with viewers!". It cannot be empty.
Description	The new description text. It can have several lines.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Type id: youtube.setTitleAndDescription

Timeout user¶

Gives someone a timeout in your YouTube live chat. They cannot write for a while. Needs a live stream.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.
Duration (seconds)	How long, in seconds. Example: 300 for 5 minutes. Starts as: `300`.
Broadcast id	Leave empty to use your latest live (or about to be live) broadcast. Or type the broadcast's ID to pick another one.

Variables it adds

Variable	What it holds
`%bannedUser%`	Name of the person
`%bannedUserId%`	Their YouTube channel ID
`%timeoutResult%`	True when it worked

Type id: youtube.timeoutUser

Unban user¶

Lifts a ban or timeout. It only works for bans and timeouts Cuebot gave during this session. For others, use YouTube Studio.

Setting	What to put in
User	Who to pick: their YouTube channel ID (starts with "UC"), their @handle, or the name of someone who chatted recently. The default is the person who started this action. Starts as: `%userId%`.

Type id: youtube.unbanUser