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

In order to to filter for Power-ups in Streamer.bot, you can create an if/else subaction and check for the variable rewardType:

message_effect
gigantify_an_emote
celebration

Variables

The following variables will be populated when this trigger executes:

		Description
`rewardCost`	`int`	cost of the reward Example: `80`
`rewardType`	`string`	type of the reward Example: `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`
`unlockedEmoteId`	`string`	ID of the unlocked emote (obviously not available for all reward types) Example: `emotesv2_f5d843cf38bf42208d022e89a9de258e`
`unlockedEmoteName`	`string`	name of the unlocked emote (obviously not available for all reward types) Example: `tawmaeKEKW`

		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`
`user`	`string`	The display name of the user Example: `TwitchUser123`
`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
`__source`	`EventType`	The event which triggered the action. This will not always exist and requires C# to access Example: `TwitchChatMessage`
`actionId`	`string`	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 Example: `twitch`
`runningActionId`	`string`	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`	`string`	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