Kick triggers¶
7TV emote added¶
Runs when an emote is added to your channel's 7TV emote set (7TV is an add-on that gives chat extra emotes).
| Setting | What to put in |
|---|---|
| Emote name | The emote name to react to, like "KEKW" (capitals must match). Leave empty to react to every new emote. |
Variables you get
| Variable | What it holds |
|---|---|
%emoteName% |
Name of the emote |
%emoteId% |
ID of the emote |
%imageUrl% |
Web link to the emote picture |
%sevenTvUser% |
Who added it on 7TV |
Type id: kick.sevenTvEmoteAdded
7TV emote removed¶
Runs when an emote is removed from your channel's 7TV emote set (7TV is an add-on that gives chat extra emotes).
| Setting | What to put in |
|---|---|
| Emote name | The emote name to react to, like "KEKW" (capitals must match). Leave empty to react to every removed emote. |
Variables you get
| Variable | What it holds |
|---|---|
%emoteName% |
Name of the emote |
%emoteId% |
ID of the emote |
%sevenTvUser% |
Who removed it on 7TV |
Type id: kick.sevenTvEmoteRemoved
Broadcaster authenticated¶
Runs when your Kick broadcaster account finishes connecting (Cuebot is allowed to use your channel). Handy to check that everything is ready.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Your Kick name |
%userId% |
Your Kick ID number |
%channelSlug% |
Your channel's web name |
Type id: kick.broadcasterAuthenticated
Channel update¶
Runs when you change your Kick stream title or category (game). Handy to announce a new game.
Variables you get
| Variable | What it holds |
|---|---|
%title% |
The new title |
%category% |
The new category |
%oldStatus% |
The title before |
%oldCategoryName% |
The category before |
%statusUpdated% |
True if the title changed |
%categoryUpdated% |
True if the category changed |
%language% |
Stream language |
Type id: kick.channelUpdate
Chat connected¶
Runs when Cuebot's live connection to your Kick chat starts working (also after a reconnect).
Variables you get
| Variable | What it holds |
|---|---|
%reason% |
A short note about why it changed |
Type id: kick.chatConnected
Chat disconnected¶
Runs when Cuebot's live connection to your Kick chat drops. Cuebot tries to reconnect by itself.
Variables you get
| Variable | What it holds |
|---|---|
%reason% |
A short note about why it dropped |
Type id: kick.chatDisconnected
Chat message¶
Runs when someone writes a message in your Kick chat. Handy for replies, word triggers or counting messages.
| 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. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the person who wrote |
%userId% |
Their Kick ID number |
%message% |
What they wrote (emotes shown by name) |
%messageId% |
ID of the message, to delete it or reply to it |
%isModerator% |
True if they are a moderator |
%isSubscriber% |
True if they are a subscriber |
%isVip% |
True if they are a VIP |
%isReply% |
True if the message replies to another message |
%replyToMessage% |
The text of the message they replied to |
Type id: kick.chatMessage
First words¶
Runs the first time someone chats in your channel during a stream. Great for a welcome message. It counts again after you go live.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the person |
%userId% |
Their Kick ID number |
%message% |
Their first message |
%messageId% |
ID of that message |
%isNewUser% |
True if Cuebot has never seen them before |
%messageCount% |
How many messages Cuebot has seen from them so far |
Type id: kick.firstWords
Follow¶
Runs when someone follows your Kick channel. Good for a thank-you message or an alert.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the new follower |
%userId% |
Their Kick ID number |
%followerCount% |
How many followers you have now, when Kick says |
Type id: kick.follow
Gift subscription¶
Runs once for every person who receives a gifted subscription. If someone gifts 5 subs, it runs 5 times, once per receiver.
| Setting | What to put in |
|---|---|
| Ignore gifts that are part of a mass gift | Tick to skip gifts that came as part of a big gift to many people. Use the Mass gift trigger to thank those once. Starts as: false. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the person who gifted |
%recipient% |
Name of the person who received it |
%gifts% |
How many subs were gifted in total |
%fromMassGift% |
True if it was part of a big gift |
%totalGifted% |
How many the gifter has gifted overall, when known |
Type id: kick.giftSubscription
Kicks gifted¶
Runs when a viewer sends Kicks (Kick's paid gifts) to your channel. Good for a thank-you or an alert.
| Setting | What to put in |
|---|---|
| Minimum Kicks | Only run when at least this many Kicks were sent. 0 runs for every gift. Example: 100. Starts as: 0. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the sender |
%kicks% |
How many Kicks were sent |
%giftName% |
Name of the gift |
%giftTier% |
Tier of the gift |
%message% |
The message that came with the gift |
Type id: kick.kicksGifted
Mass gift subscription¶
Runs once when someone gifts several subscriptions at the same time. Use it to thank the gifter once instead of once per receiver.
| Setting | What to put in |
|---|---|
| Minimum gifts | Only run when at least this many subs were gifted at once. Example: 5. Starts as: 1. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the gifter |
%gifts% |
How many subs were gifted |
%recipients% |
Names of the receivers, separated by commas |
%totalGifted% |
How many the gifter has gifted overall, when known |
Type id: kick.massGiftSubscription
Message deleted¶
Runs when a message is deleted from your Kick chat.
Variables you get
| Variable | What it holds |
|---|---|
%messageId% |
ID of the deleted message |
Type id: kick.messageDeleted
People in chat (every few minutes)¶
Runs now and then with the list of people who chatted lately, so you can reward everyone who is around. How often and how long "lately" is are set in the Users settings.
Variables you get
| Variable | What it holds |
|---|---|
%users% |
The list of people who are around |
%userNames% |
Their names, separated by commas |
%count% |
How many people are around |
%isLive% |
True if your Kick stream is live |
%title% |
Your stream title |
%viewerCount% |
How many people watch right now |
Type id: kick.presentViewers
Raid / host¶
Runs when another Kick channel sends its viewers to you (a host or raid). Good for a thank-you shout-out.
| Setting | What to put in |
|---|---|
| Minimum viewers | Only run when at least this many viewers come along. 0 runs for every host. Example: 10. Starts as: 0. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the channel that sent viewers |
%viewers% |
How many viewers came |
%message% |
The message that came with it |
Type id: kick.host
Resubscription¶
Runs when a subscriber renews and has been with you for more than one month.
| Setting | What to put in |
|---|---|
| Minimum months | Only run when they have subscribed at least this many months. 0 runs for every renewal. Example: 12. Starts as: 0. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the subscriber |
%userId% |
Their Kick ID number |
%months% |
How many months in total |
Type id: kick.resubscription
Reward redemption¶
Runs when a viewer uses one of your Kick channel rewards. The reward can be waiting, accepted or rejected.
| Setting | What to put in |
|---|---|
| Reward title | The title of the reward to react to, like "Hydrate!". Capital letters do not matter. Leave empty to react to every reward. |
| Status | Pick when to run: "pending" = waiting for you to accept or reject, "accepted" = you accepted it, "rejected" = you rejected it. "Any" runs for all of them. Options: Any, pending, accepted, rejected. Starts as: Any. |
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the viewer |
%rewardTitle% |
Title of the reward |
%rewardId% |
ID of the reward |
%rewardCost% |
What the reward costs |
%userInput% |
The text the viewer typed, if the reward asks for text |
%status% |
pending, accepted or rejected |
%redemptionId% |
ID of this redemption, to accept or reject it |
%counter% |
How many times this reward was redeemed |
%userCounter% |
How many times this viewer redeemed it |
Type id: kick.rewardRedemption
Stream offline¶
Runs when your Kick stream ends. Handy for a goodbye message or tidying up.
Variables you get
| Variable | What it holds |
|---|---|
%title% |
Your stream title |
%startedAt% |
When the stream started |
%endedAt% |
When the stream ended |
Type id: kick.streamOffline
Stream online¶
Runs when your Kick stream goes live. Use it to say hello, switch scenes or reset counters.
Variables you get
| Variable | What it holds |
|---|---|
%title% |
Your stream title |
%startedAt% |
When the stream started |
%categoryName% |
Your category (game) |
%livestreamId% |
ID of this stream on Kick |
Type id: kick.streamOnline
Subscription¶
Runs when someone subscribes to your Kick channel for the first time. Good for a thank-you message or alert.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the new subscriber |
%userId% |
Their Kick ID number |
%months% |
How many months (1 for a new sub) |
Type id: kick.subscription
User banned¶
Runs when someone is banned from your Kick chat. Use it to log bans or say something.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the banned person |
%userId% |
Their Kick ID number |
%moderator% |
Who banned them |
%reason% |
The reason, if one was given |
Type id: kick.userBanned
User timed out¶
Runs when someone gets a timeout (a short mute) in your Kick chat.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the person |
%userId% |
Their Kick ID number |
%moderator% |
Who gave the timeout |
%duration% |
Length of the timeout in seconds |
%reason% |
The reason, if one was given |
Type id: kick.userTimedOut
User unbanned¶
Runs when someone is unbanned, or their timeout is lifted, in your Kick chat.
Variables you get
| Variable | What it holds |
|---|---|
%user% |
Name of the person |
%userId% |
Their Kick ID number |
%moderator% |
Who lifted it |
Type id: kick.userUnbanned
Viewer count update¶
Runs each time Cuebot checks how many people are watching your Kick stream (about once a minute). Use it to react to viewer numbers.
Variables you get
| Variable | What it holds |
|---|---|
%viewerCount% |
How many people watch right now |
Type id: kick.viewerCountUpdate