Kick sub-actions

Add broadcaster information

Looks up your own Kick channel details and saves them as variables for the next steps. It has no settings.

Variables it adds

Variable	What it holds
%broadcastUser%	Your Kick name
%broadcastUserId%	Your Kick ID number
%broadcasterChannelSlug%	Your channel's web name
%broadcasterIsLive%	True if you are live
%broadcasterTitle%	Your stream title
%broadcasterCategory%	Your category
%broadcasterViewerCount%	How many people watch
%botUser%	Your bot account's name

Type id: kick.addBroadcasterInfo

Add random users

Picks random viewers from the people who chatted lately and saves them as variables. Great for "pick a random viewer" commands.

Setting	What to put in
How many	How many people to pick. Example: 3. Starts as: 1.
Leave out the broadcaster and the bot	Tick to never pick you or your bot account. Starts as: true.
Leave out the triggering user	Tick to never pick the person who started this action. Starts as: false.
Variable name start	A word put in front of the variable names. Empty uses "randomUser", which gives %randomUser0%, %randomUser1% and so on. Starts as: randomUser.

Variables it adds

Variable	What it holds
%randomUser0%	Name of the first person picked (then randomUser1, randomUser2...)
%randomUserId0%	Their Kick ID number
%randomUserCount%	How many people were found
%randomUserFound%	True if at least one person was found

Type id: kick.addRandomUsers

Add user to group

Puts a Kick user into one of your groups (saved lists of people). Groups are shared with the rest of Cuebot.

Setting	What to put in
Group	The name of the group (a saved list of people), like "VIPs".
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.
User id	Kick number ID of the user. If it is filled in, Cuebot uses it first and only falls back to the name when it is empty. Starts as: %userId%.
Create the group if missing	Tick to make the group if it does not exist yet. Untick to get an error instead. Starts as: true.

Variables it adds

Variable	What it holds
%groupUserAdded%	True if the person was added (false if they were already in)

Type id: kick.addUserToGroup

Ban user

Bans someone from your Kick chat for good.

Setting	What to put in
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.
Reason	Why they are banned (optional). It can be shown to moderators.

Variables it adds

Variable	What it holds
%bannedUser%	Name of the banned person
%bannedUserId%	Their Kick ID number
%banResult%	True when it worked

Type id: kick.banUser

Configure rewards

Turns many Kick rewards on, off, paused or resumed in one go. Great for "stream mode" and "BRB mode". Only works on rewards made by Cuebot.

Setting	What to put in
Enable	Rewards to turn on. One per line: a reward title, ID or group name.
Disable	Rewards to turn off. One per line: a reward title, ID or group name.
Pause	Rewards to pause (viewers cannot use them for now). One per line: title, ID or group name.
Unpause	Rewards to resume after a pause. One per line: title, ID or group name.
Disable rewards that are in no group	Tick to also turn off every reward that is in no group and not named above. Starts as: false.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many Kick refused to change

Type id: kick.configureRewards

Delete chat message

Deletes one message from your Kick chat. Good for removing spam from a command or trigger.

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: kick.deleteMessage

Look up a Kick user

Looks up another Kick user and saves their details as variables for the next steps. Handy for a shout-out command.

Setting	What to put in
Target user	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to look up the person who started this action. Starts as: %userName%.
Variable name start	A word put in front of the variable names. With "target" you get %targetUserName% and %targetStreamTitle%. Empty uses "target". Starts as: target.

Variables it adds

Variable	What it holds
%targetUserName%	Their name
%targetUserId%	Their Kick ID number
%targetProfilePicture%	Web link to their picture
%targetChannelSlug%	Their channel's web name
%targetIsLive%	True if they are live
%targetStreamTitle%	Their stream title
%targetCategory%	What they play
%targetDescription%	Their channel description

Type id: kick.getUserInfo

Remove timeout

Ends someone's timeout in your Kick chat so they can write again.

Setting	What to put in
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.

Variables it adds

Variable	What it holds
%unTimedOutUser%	Name of the person
%unTimedOutUserId%	Their Kick ID number
%unTimedOutResult%	True when it worked

Type id: kick.untimeoutUser

Remove user from group

Takes a Kick user out of one of your groups (saved lists of people).

Setting	What to put in
Group	The name of the group (a saved list of people), like "VIPs".
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.
User id	Kick number ID of the user. If it is filled in, Cuebot uses it first and only falls back to the name when it is empty. Starts as: %userId%.

Variables it adds

Variable	What it holds
%groupUserRemoved%	True if the person was in the group and is removed

Type id: kick.removeUserFromGroup

Reply to message

Writes a reply to one message in your Kick chat, shown under that message.

Setting	What to put in
Message	What to write, like "Thanks for asking!".
Message id to reply to	ID of the message to reply to. The default is the message that started this action. Starts as: %messageId%.
Send as bot account	Tick to write as your bot account instead of your own account. The bot must be signed in on the Kick page. Starts as: false.
Use the broadcaster when the bot is not signed in	Tick to write as you if the bot account is not signed in. Untick to get an error instead. Starts as: true.

Variables it adds

Variable	What it holds
%kickMessageId%	ID of the reply Cuebot just sent

Type id: kick.replyToMessage

Reward group: set enabled state

Turns every reward in a reward group on or off. Only works on rewards made by Cuebot.

Setting	What to put in
Reward group	The reward group's name. You set a reward's group on the Kick page, under Channel rewards.
State	"Enabled" turns them on, "Disabled" turns them off, "Toggle" flips them (all on, unless one is already on). Options: Enabled, Disabled, Toggle. Starts as: Enabled.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many Kick refused to change

Type id: kick.setRewardGroupEnabled

Reward group: set paused state

Pauses or resumes every reward in a reward group. Only works on rewards made by Cuebot.

Setting	What to put in
Reward group	The reward group's name. You set a reward's group on the Kick page, under Channel rewards.
State	"Paused" pauses them, "Unpaused" resumes them, "Toggle" flips them (all paused, unless one is already paused). Options: Paused, Unpaused, Toggle. Starts as: Paused.

Variables it adds

Variable	What it holds
%rewardsChanged%	How many rewards were changed
%rewardsSkipped%	How many Kick refused to change

Type id: kick.setRewardGroupPaused

Reward: accept or reject all pending redemptions

Accepts or rejects all redemptions that are still waiting, for one reward or for all rewards Cuebot manages. Rejecting gives the points back.

Setting	What to put in
Reward	The reward's title or ID. Leave empty for every reward.
Action	"Accept" marks them done. "Reject" refuses them (the viewers get their points back). Options: Accept, Reject. Starts as: Accept.

Variables it adds

Variable	What it holds
%redemptionsUpdated%	How many redemptions were handled
%redemptionFailures%	Which ones failed and why

Type id: kick.updatePendingRedemptions

Reward: accept or reject redemption

Accepts or rejects one reward redemption that is waiting. Handy to accept it after your action did its job.

Setting	What to put in
Redemption id	ID of the redemption. The default is the one that started this action. You can give several, separated by commas. Starts as: %redemptionId%.
Action	"Accept" marks it done. "Reject" refuses it (the viewer gets their points back). Options: Accept, Reject. Starts as: Accept.

Variables it adds

Variable	What it holds
%redemptionUpdated%	True if it worked for every redemption
%redemptionFailures%	Which ones failed and why

Type id: kick.updateRedemption

Reward: create

Makes a new channel reward on Kick. You can change or delete it later with Cuebot.

Setting	What to put in
Title	The reward name viewers see, like "Hydrate!". Up to 50 letters.
Cost	How many channel points it costs. Example: 100. Starts as: 100.
Description	A short text under the name (optional). Up to 200 letters.
Background colour (#RRGGBB)	The reward color as #RRGGBB, like "#00E701" (Kick green). Empty keeps the default. Starts as: #00E701.
Enabled	Tick to let viewers use it right away. Starts as: true.
Viewer must enter text	Tick to make the viewer type a text when they redeem it. Starts as: false.
Skip the request queue (accept automatically)	Tick to accept redemptions automatically, without waiting for you. Starts as: false.

Variables it adds

Variable	What it holds
%createdRewardId%	ID of the new reward
%createdRewardTitle%	Title of the new reward

Type id: kick.createReward

Reward: delete

Deletes a Kick channel reward for good. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).

Type id: kick.deleteReward

Reward: get counters (counter, userCounter)

Reads how many times a reward was redeemed (Cuebot keeps this count, Kick does not) and saves it as variables.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
For user	Whose personal count to read: a Kick user name or ID. The default is the person who started this action. Empty gives no personal count. Starts as: %userId%.

Variables it adds

Variable	What it holds
%counter%	How many times the reward was redeemed
%userCounter%	How many times this person redeemed it

Type id: kick.getRewardCounter

Reward: get info

Reads a reward's settings from Kick and saves them as variables for the next steps.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).

Variables it adds

Variable	What it holds
%rewardId%	ID of the reward
%rewardTitle%	Its title
%rewardDescription%	Its description
%rewardCost%	Its cost
%rewardBackgroundColor%	Its color
%rewardEnabled%	True if it is turned on
%rewardPaused%	True if it is paused
%rewardUserInputRequired%	True if viewers must type a text
%rewardSkipsQueue%	True if redemptions are accepted automatically

Type id: kick.getRewardInfo

Reward: reset counter

Sets the redemption count of one reward back to zero. Cuebot keeps this count, not Kick.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).

Type id: kick.resetRewardCounter

Reward: reset user counters

Sets every viewer's personal redemption count for one reward back to zero. Cuebot keeps these counts, not Kick.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).

Type id: kick.resetRewardUserCounters

Reward: set background colour

Changes the background color of a Kick reward. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Colour (#RRGGBB)	The new color as #RRGGBB, like "#FF0000" for red. Starts as: #00E701.

Type id: kick.setRewardColor

Reward: set cost

Changes how many channel points a Kick reward costs. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Cost	The new cost in channel points. Example: 250. Starts as: 100.

Type id: kick.setRewardCost

Reward: set description

Changes the short text under a Kick reward's name. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Description	The new description. Up to 200 letters.

Type id: kick.setRewardDescription

Reward: set enabled

Turns a Kick reward on or off. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Enabled	Tick to turn the reward on. Untick to turn it off. Starts as: true.

Type id: kick.setRewardEnabled

Reward: set paused

Pauses or resumes a Kick reward. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Paused	Tick to pause the reward (nobody can use it for now). Untick to resume it. Starts as: true.

Type id: kick.setRewardPaused

Reward: set skip request queue

Chooses whether a Kick reward is accepted automatically. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Accept redemptions automatically	Tick to accept redemptions automatically. Untick to make them wait for you. Starts as: true.

Type id: kick.setRewardSkipQueue

Reward: set title

Renames a Kick reward. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Title	The new name viewers see. Up to 50 letters.

Type id: kick.setRewardTitle

Reward: set viewer input required

Chooses whether viewers must type a text when they redeem a Kick reward. Only works on rewards made by Cuebot.

Setting	What to put in
Reward	The reward's title or ID. Leave empty to use the reward that was just redeemed (when this runs from a Kick reward trigger).
Viewer must enter text	Tick to make viewers type a text. Untick to not ask for one. Starts as: true.

Type id: kick.setRewardUserInput

Send message to channel

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

Setting	What to put in
Message	What to write, like "Welcome in, %user%!". Very long messages are cut into several messages.
Send as bot account	Tick to write as your bot account instead of your own account. The bot must be signed in on the Kick page. Starts as: false.
Use the broadcaster when the bot is not signed in	Tick to write as you if the bot account is not signed in. Untick to get an error instead. Starts as: true.

Variables it adds

Variable	What it holds
%kickMessageId%	ID of the message Cuebot just sent

Type id: kick.sendMessage

Set channel category (kickCategory, category.id, category.name, category.success)

Changes your Kick stream category (the game or topic).

Setting	What to put in
Category	The category name, like "Just Chatting", or its Kick number ID. A name is searched on Kick and the best match is used.

Variables it adds

Variable	What it holds
%kickCategory%	Name of the category that was set
%kickCategoryId%	Kick ID of that category
%category.success%	True when the category was changed

Type id: kick.setCategory

Set channel title

Changes your Kick stream title.

Setting	What to put in
Title	The new title, like "Playing with viewers!". It cannot be empty.

Variables it adds

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

Type id: kick.setTitle

Timeout user

Gives someone a timeout in your Kick chat. They cannot write for a while.

Setting	What to put in
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.
Duration (seconds)	How long, in seconds. Kick uses whole minutes, so it is rounded up (30 becomes 1 minute). The most is 7 days. Example: 300 for 5 minutes. Starts as: 300.
Reason	Why they get a timeout (optional).

Variables it adds

Variable	What it holds
%timedOutUser%	Name of the person
%timedOutUserId%	Their Kick ID number
%timeoutResult%	True when it worked

Type id: kick.timeoutUser

Unban user

Lifts a ban from someone in your Kick chat.

Setting	What to put in
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.

Variables it adds

Variable	What it holds
%unbannedUser%	Name of the person
%unbannedUserId%	Their Kick ID number
%unbanResult%	True when it worked

Type id: kick.unbanUser

User in group

Checks if a Kick user is in one of your groups. Cuebot then follows the True or False path below this step.

Setting	What to put in
Group	The name of the group (a saved list of people), like "VIPs".
User	The Kick user name, like "SomeViewer", or their Kick number ID. Leave the default to use the person who started this action. Starts as: %userName%.
User id	Kick number ID of the user. If it is filled in, Cuebot uses it first and only falls back to the name when it is empty. Starts as: %userId%.
Save the answer in variable	The variable name to save the answer in. Example: "inGroup" lets you use %inGroup% later. Starts as: inGroup.

Paths it can take: True, False.

Variables it adds

Variable	What it holds
%inGroup%	True if the person is in the group (or the name you chose above)

Type id: kick.userInGroup