Automatic Reward Redemption

Details

The Automatic Reward Redemptions work for both default rewards as well as the newly introduced Power-ups.

Default Rewards

The default rewards are those made by Twitch like "Highlight My Message". You can either choose to enable or disable them, but you cannot delete and only restrictively edit them.

Default Rewards

Power Ups

Power-ups have been added to Twitch on June 12, 2024 and are available in your Channel Reward window. It allows viewers to do specific interactions with bits.

Default Rewards

Parameters

Rewardrequired

Select

Select any or a specific automatic channel reward type.

Variables

The following variables will be populated when this trigger executes:

		Description
`gigantifiedEmoteId`	`string`	the ID of the gigantified emote (not available for all reward types) Example: `emotesv2_cfc898bcdd5d447bb3ca5ff8a3d62514`
`gigantifiedEmoteName`	`string`	the name of the gigantified emote (not available for all reward types) Example: `tawmaeHUH`
`gigantifiedEmoteUrl`	`string`	the image URL of the gigantified emote (not available for all reward types) Example: `https://static-cdn.jtvnw.net/emoticons/v2/emotesv2_cfc898bcdd5d447bb3ca5ff8a3d62514/default/dark/3.0`
`rewardCost`	`int`	channel point cost of the reward Example: `100`
`rewardType`	`string`	Type of the reward Possible values: `send_highlighted_message`, `random_sub_emote_unlock`, `chosen_sub_emote_unlock`, `chosen_modified_sub_emote_unlock`, `single_message_bypass_sub_mode`, `message_effect`, `gigantify_an_emote`, `celebration` Example: `gigantify_an_emote`
`unlockedEmoteId`	`string`	ID of the unlocked emote (not available for all reward types) Example: `emotesv2_f5d843cf38bf42208d022e89a9de258e`
`unlockedEmoteName`	`string`	name of the unlocked emote (not available for all reward types) Example: `tawmaeKEKW`
`userInput`	`string`	the input message of the redeeming user (not available for all reward types) Example: `This is a test message!`

		Description
`badgeCount`	`number`	The count of badges this user has Example: `3`
`badges`	`List<Twitch.Common.Models.Badge>`	A C# accessible list of emotes used in the chat message
`isModerator`	`boolean`	Is this user a moderator? Example: `true`
`isSubscribed`	`boolean`	Is this user subscribed? Example: `true`
`isVip`	`boolean`	Is this user a VIP? Example: `true`
`monthsSubscribed`	`number`	The amount of months the user is subscribed Example: `3`
`subscriptionTier`	`number`	The subscription tier (T1 = 1000, T2 = 2000, T3 = 3000) (only available if `isSubscribed` is `True`) Example: `3000`
`user`	`string`	The display name of the user Example: `TwitchUser123`
`userGroups`	`string`	0.2.5 Comma-delimited list of groups the user is in Example: `Awesome Streamers,Discord Peeps,Top Contributors`
`userId`	`string`	Unique user identifier Example: `718933593`
`userName`	`string`	The login name of the user Example: `twitchuser123`
`userPreviousActive`	`DateTime`	When was this user last active? Example: `8/4/2023 10:56:06 AM`
`userType`	`string`	Streaming service of this user Example: `twitch`

		Description
`bits`	`number`	The amount of bits donated Example: `200`
`color`	`string`	Hex value of the user's chat color Example: `#e5e5e5`
`colorB`	`string`	The blue in RGB of the user's chat color Example: `229`
`colorG`	`string`	The green in RGB of the user's chat color Example: `229`
`colorR`	`string`	The red in RGB of the user's chat color Example: `229`
`emoteCount`	`number`	Number of emotes in the chat message
`emotes`	`List<Twitch.Common.Models.Emote>`	A C# accessible list of emotes used in the chat message
`firstMessage`	`boolean`	Is this user a first time chatter? Example: `true`
`input#`	`string`	The `#` word of the message entered, spaces are delimiters and variable names are 0 indexed, so `input0` would give the first word, `input1` would give the second, and so on
`inputEscaped#`	`string`	The indexed word escaped
`inputUrlEncoded#`	`string`	The indexed word URL encoded
`isAction`	`boolean`	Is this message a `/me` action? Example: `true`
`isHighlight`	`boolean`	Is this message a Twitch Highlight? Example: `true`
`isReply`	`boolean`	Is this message a reply? Example: `true`
`message`	`string`	Text content of the chat message Example: `Hello!`
`messageCheermotesStripped`	`string`	The chat message with cheer emotes stripped. Example: `Hello!`
`messageStripped`	`string`	The chat message with emotes stripped Example: `Hello!`
`msgId`	`string`	Twitch's message identifier Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`rawInput`	`string`	The message entered
`rawInputEscaped`	`string`	The message escaped
`rawInputUrlEncoded`	`string`	The message URL encoded
`reply.msgBody`	`string`	The text content of the reply, Spaces are replaced by `\s` Example: `My\schat\smessage`
`reply.msgId`	`string`	The message id of the reply Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`reply.threadMsgId`	`string`	The message id of the thread Example: `a126e8a8-43f7-4a14-8990-e8c3feea76d8`
`reply.threadUserLogin`	`string`	The user login name of the thread Example: `twitchuser123`
`reply.userId`	`string`	The user id from the user who sent the reply Example: `718933593`
`reply.userLogin`	`string`	The user login from the user who sent the reply Example: `twitchuser123`
`reply.userName`	`string`	The user name from the user who sent the reply Example: `TwitchUser123`
`role`	`number`	The role of the user 1=`Viewer`, 2=`VIP`, 3=`Moderator`, 4=`Broadcaster` Example: `1`

General variables are generated by all triggers and are available within all action executions.

		Description
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access, read more Example: `TwitchChatMessage`
`actionId`	`Guid`	The unique ID of the action being executed Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`actionName`	`string`	The name of the action being executed Example: `My Action`
`actionQueuedAt`	`DateTime`	The timestamp of when action was queued Example: `12/21/2023 9:25:21 AM`
`eventSource`	`EventSource`	The service of the event which triggered the action. This will not always exist and requires C# to access, read more Example: `twitch`
`runningActionId`	`Guid`	The unique ID of this running action instance within the queue Example: `c83dd939-9f86-4435-b07c-b6e7e3eef134`
`triggerCategory`	`string`	The category of the trigger which executed the action Example: `Twitch/Chat`
`triggerId`	`Guid`	The unique id of the trigger with executed the action Example: `2cd1495a-e50c-45d2-8bb5-ffe9c3dff243`
`triggerName`	`string`	The name of the trigger which executed the action Example: `Chat Message`

Goal Progress

Trigger for the progression of a Twitch goal

Reward Redemption

Trigger for a Twitch Reward Redemption