# Kick

## Getting Started

Mix It Up connects to your Kick channel so chat, channel points, Kicks gifts, subscriptions, and channel settings can drive your stream automation.

## Actions

Kick actions allow you to perform actions on your Kick channel, such as setting the title, category, custom tags, and updating Channel Point Rewards.

This action supports the following options:

- **Set Title:** Sets the title for the channel.
- **Set Game:** Sets the game/category for the channel.
- **Set Custom Tags:** Sets the custom tags for the channel.
- **Update Channel Point Reward:** Updates a Channel Point Reward in your stream. On Kick this can target **any** reward on the channel, not only ones created by Mix It Up. The dropdown is populated from Kick's full `channels/rewards` list with no origin filter, so rewards created directly on Kick's website work identically to ones created through the [Kick Channel Point Commands](/docs/platforms/kick#kick-channel-point-commands) page.

## Events

### Kick Channel Stream Start
This event will run when your stream goes from offline to online. It is often used to send out Discord and social media notices to alert users that your stream is starting. This event is only triggered once per-application launch. This event provides no additional special identifiers.

### Kick Channel Stream Stop
This event will run when your stream goes from online to offline. It is often used to send out Discord and social media notices to alert users that your stream has ended. This event is only triggered once per-application launch. This event provides no additional special identifiers.

### Kick Channel Updated
This event triggers when a channel update is performed such as changing your category, title, or other livestream meta data. When it fires, this event provides the following additional special identifiers: `$streamtitle`, `$streamgameid`, `$streamgameimage`, `$streamgame`, and `$streamgamename`. Any other [Special Identifiers](/docs/reference/special-identifiers#user) can also be used here.

### Kick Channel Followed
This event will run the first time a user follows during this specific session of Mix It Up. This means that if a user follows, unfollows, and then re-follows quickly, it will only run the first time. This event is only triggered once per-user, per-application launch.

This event provides no additional special identifiers, however, it is often used with the [User](/docs/reference/special-identifiers#user) special identifiers.

### Kick Channel Subscribed
This event will run when a user subscribes to your channel. This event is only triggered once per-user, per-application launch.

In addition to regular [User](/docs/reference/special-identifiers#user) Special Identifiers, this event provides the following additional Special Identifiers:
- $usersubmonths = The number of months the user has been subscribed for (EX: 1)
- $usersubtier = The tier number of the subscription, always 1 on Kick (EX: 1)
- $usersubplan = The tier of the plan, always Tier 1 on Kick
- $usersubplanname = The name of the plan, always Tier 1 on Kick

> Kick has a single subscription product with no tiers and no streamer-set plan names, which is why every Kick subscription is reported as Tier 1. These identifiers are filled in so commands written against Twitch or YouTube keep working when pointed at Kick.

### Kick Channel Resubscribed
This event will run when a user resubscribes to your channel. This event is only triggered once per-user, per-application launch.

In addition to regular [User](/docs/reference/special-identifiers#user) Special Identifiers, this event provides the following additional Special Identifiers:
- $usersubmonths = The cumulative number of months that the user has been subscribed for
- $usersubstreak = The continuous number of months that the user has been subscribed for
- $usersubtier = The tier number of the subscription, always 1 on Kick (EX: 1)
- $usersubplan = The tier of the plan, always Tier 1 on Kick
- $usersubplanname = The name of the plan, always Tier 1 on Kick

### Kick Channel Subscription Gifted
This event will run for every user that is gifted a subscription by another user in your channel. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user that GIFTED the subscription (Ex: $username), while the [Target User](/docs/reference/special-identifiers#target-user) Special Identifiers reference the user that RECEIVED the subscription (Ex: $targetusername). This event provides the following additional Special Identifiers:
- $isanonymous = Whether the gifter is anonymous or not (EX: true)
- $usersubtier = The tier number of the gifted subscription, always 1 on Kick (EX: 1)
- $usersubplan = The tier of the plan, always Tier 1 on Kick
- $usersubplanname = The name of the plan, always Tier 1 on Kick

### Kick Channel Mass Subscriptions Gifted
This event will run once for each time a user in your channel gifts a **set** of subscriptions. This is when a user selects a number of subs to gift all at once to users in the channel. For example, if a user gifts 5 subscriptions to your channel, this event will be run once, while the [Kick Channel Subscription Gifted](/docs/platforms/kick#kick-channel-subscription-gifted) will be run 5 times, once for each user. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user that GIFTED the subscription.

What determines whether this command or the Channel Subscriptions Gifted command will run is based on what is set for the Mass Gifted Subscriptions Filter Amount under Settings -> Commands. This option is designed to help reduce the spam of subscription gifted commands and provide a better experience for your stream. For example, if this option is enabled and the amount is set to 5, then any time 5 OR LESS subscriptions are gifted at once, it will ONLY run the regular Subscription Gifted event for each subscription. If MORE THAN 5 are gifted, then it will ONLY run the Mass Subscriptions Gifted event once. Note that this will cause the processing of Subscription Gifted & Mass Subscription Gifted events to be slightly delayed, typically less than 10 seconds.

This event provides the following additional Special Identifiers:
- $subsgiftedamount = The number of subscriptions gifted for this specific instance
- $subsgiftedlifetimeamount = The lifetime amount of subs for the gifter
- $isanonymous = Whether the gifter is anonymous or not (EX: true)
- $usersubtier = The tier number of the gifted subscriptions, always 1 on Kick (EX: 1)
- $usersubplan = The tier of the plan, always Tier 1 on Kick
- $usersubplanname = The name of the plan, always Tier 1 on Kick

### Kick Channel Points Redeemed
This event is run when the reward either has "Should Redemption Skip Queue" enabled OR the reward was approved by a moderator in the rewards queue. Pending rewards will not trigger Mix It Up commands. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user who triggered the event. This event provides the following additional Special Identifiers:
- $rewardname = The name of the reward
- $rewardcost = The cost of the reward
- $message = An optional message that the user can supply when the reward is redeemed

### Kick Channel Kicks Gifted
This event is run when any form of Kicks are gifted in your channel. The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user who triggered the event. This event provides the following additional Special Identifiers:
- $kicksamount = The number of kicks gifted
- $message = An optional message that the user can supply when gifting Kicks
- $giftname = The name of the Kicks gifted
- $gifttype = The type of the Kicks gifted
- $gifttier = The tier of the gift

## Kick Channel Point Commands

> Note: Kick has a **maximum limit of 15 Channel Point** rewards. If you reach this limit, you'll need to go to the Channel Points editor and remove an existing reward before adding a new one. This includes both enabled and disabled rewards.

The Kick Channel Points feature allows you to create commands that can be triggered automatically when specific Kick Channel Point Rewards are redeemed in your Kick channel.

- Commands assigned to a reward will trigger **ONLY** when the reward either has "Should Redemption Skip Queue" enabled OR the reward was approved by a moderator in the rewards queue. Pending rewards will not trigger Mix It Up commands.

- If the Channel Point Reward already exists on Kick or you want to create it directly on Kick's website first, you would use the "Add Command To Existing Reward" option. This will create a Mix It Up command that will be run when that Channel Point Reward is redeemed.

- If you have **not** created the Channel Point Reward yet and you want to allow Mix It Up to be able to control the Channel Point Reward with the [Kick action](/docs/platforms/kick#actions), then you'll need to use the "Create New Channel Point Reward" option. This will create a brand new Channel Point Reward with the name you specify and then create a Mix It Up command that will be run when that Channel Point Reward is redeemed. Details of your Channel Point Reward beyond the name of it can be edited on Kick's website by clicking on the "Channel Point Editor" button.

Kick Channel Point commands provide the following additional Special Identifiers:
- $rewardname = The name of the reward
- $rewardcost = The cost of the reward
- $message = An optional message that the user can supply when the reward is redeemed

Any Kick Channel Point Reward on your channel can be dynamically updated via the [Kick action](/docs/platforms/kick#actions) to do things such as enabling/disabling rewards & updating reward information. There is no restriction to only rewards created with the "Create New Channel Point Reward" option: Mix It Up does not track which rewards it created, so both the "Create New" and "Add Command To Existing Reward" paths behave identically, and the Kick action's reward dropdown lists every reward on the channel (including ones linked via "Add Command To Existing Reward", or not linked to any command at all).

## Kick Kicks Commands

The Kick Kicks commands feature allows you to create dedicated commands for when certain amounts of Kicks are gifted in your channel.

Commands can be set up to either trigger when a specific amount of Kicks are gifted or when a range of Kicks are gifted. When Kicks are gifted in your channel, commands for specific amounts are checked first to see if any match. After that, commands with ranges are checked in order of increasing range amount. This can allow you to have multiple commands that overlap in both specific amounts and ranges, with priority being given to the smallest ones.

For example, let's say you have three commands in total:

**Command A:** Specific Amount: 50
**Command B:** Range: 40 - 60
**Command C:** Range: 1 - 100

If **50** Kicks are gifted, then **Command A** will be triggered because it matches the specific amount. If **51** Kicks are gifted, then **Command B** will be triggered because it is the smallest range that encompasses that amount. If **80** Kicks are gifted, then **Command C** will be triggered because it is the last remaining range that is applicable.

The [User](/docs/reference/special-identifiers#user) Special Identifiers reference the user who triggered the event. This event provides the following additional Special Identifiers:
- $kicksamount = The number of Kicks gifted
- $message = An optional message that the user can supply when gifting Kicks
- $giftname = The name of the Kicks gifted
- $gifttype = The type of the Kicks gifted
- $gifttier = The tier of the gift
