Twitch flow nodes

Connect Twitch before using these nodes. See how nodes work for the node diagrams and running a flow to enable your automation.

All Twitch triggers need an active connection and have no inputs. The Twitch actions always continue through Done; check Success and read Error to find out whether they worked.

Direct actions configured on the plugin's pages can run alongside flows. Use cheers, subscriptions, and redeems to configure those actions and understand how their switches affect bracket triggers.

Bits

Twitch Cheer

Fires when someone cheers bits in your channel.

Twitch CheerTriggeredUser NameBitsMessageIs Anonymous
Outputs
TriggeredFlow
User NameString
Anonymous for anonymous cheers.
BitsNumber
MessageString
Is AnonymousBoolean
Properties
Minimum Bits
Only fire for cheers of at least this many bits, 0 to 1,000,000. Default 0.

Cheer Bracket Activated

Fires when a cheer lands in one of the bit brackets on the Bits/Cheers page.

Cheer Bracket ActivatedTriggeredUser NameBitsMessageIs AnonymousSection NameBracket BitsIntensityDuration
Outputs
TriggeredFlow
User NameString
BitsNumber
MessageString
Is AnonymousBoolean
Section NameString
Bracket BitsNumber
The bracket's bit threshold.
IntensityNumber
The bracket's intensity.
DurationNumber
The bracket's duration.
Properties
Section Keyword
Only fire for the section with this keyword. Empty fires for every section.
Min Bracket Bits
Only fire for brackets of at least this many bits, 0 to 1,000,000. Default 0.

The Bits/Cheers master switch and matching section must be enabled. See cheer matching for keyword and bracket rules. The direct device action also runs if shockers are selected. To use only this bracket trigger, leave the section enabled and clear its shocker selection.

Subscriptions

Twitch Subscribe

Fires when someone subscribes.

Twitch SubscribeTriggeredUser NameTierIs Gift
Outputs
TriggeredFlow
User NameString
TierNumber
1, 2, or 3.
Is GiftBoolean
Properties
Tier Filter
Any Tier, Tier 1, Tier 2, or Tier 3. Default Any Tier.

Twitch Gift Subs

Fires when someone gifts subscriptions.

Twitch Gift SubsTriggeredUser NameGift CountTierTotal GiftedIs Anonymous
Outputs
TriggeredFlow
User NameString
Anonymous for anonymous gifts.
Gift CountNumber
TierNumber
Total GiftedNumber
The gifter's running total in your channel, when Twitch shares it.
Is AnonymousBoolean
Properties
Minimum Gifts
Only fire for at least this many gifts at once, 1 to 100. Default 1.

Twitch Resub

Fires when someone resubscribes and shares a message.

Twitch ResubTriggeredUser NameMessageTierTotal MonthsStreak Months
Outputs
TriggeredFlow
User NameString
MessageString
TierNumber
Total MonthsNumber
Streak MonthsNumber
0 when the subscriber hides their streak.

Subscription Bracket Activated

Fires when a gifted sub lands in one of the brackets on the Subs / Gifted Subs page.

Subscription Bracket ActivatedTriggeredUser NameGift CountTierTotal GiftedIs AnonymousTier NameBracket CountIntensityDuration
Outputs
TriggeredFlow
User NameString
Gift CountNumber
TierNumber
Total GiftedNumber
Is AnonymousBoolean
Tier NameString
The section name, Tier 1 to Tier 3 by default.
Bracket CountNumber
The bracket's gift threshold.
IntensityNumber
The bracket's intensity.
DurationNumber
The bracket's duration.
Properties
Tier Filter
Any Tier, Tier 1, Tier 2, or Tier 3. Default Any Tier.
Min Bracket Count
Only fire for brackets of at least this many gifts, 0 to 10,000. Default 0.

This only fires for gifted subs, and only when the Subs / Gifted Subs page is enabled and the tier's section is enabled and set to Brackets mode.

Follows and raids

Twitch Follow

Fires when someone follows your channel, including people who follow again after unfollowing.

Twitch FollowTriggeredUser NameUser ID
Outputs
TriggeredFlow
User NameString
User IDString

Twitch Raid

Fires when another channel raids yours.

Twitch RaidTriggeredRaider NameViewer Count
Outputs
TriggeredFlow
Raider NameString
Viewer CountNumber
Properties
Minimum Viewers
Only fire for raids of at least this many viewers, 0 to 100,000. Default 0.

Hype trains

Hype Train Start

Fires when a hype train begins.

Hype Train StartTriggeredLevelTotal PointsGoal
Outputs
TriggeredFlow
LevelNumber
Total PointsNumber
GoalNumber

Hype Train Progress

Fires as a hype train gains points.

Hype Train ProgressTriggeredLevelProgressGoalTotal Points
Outputs
TriggeredFlow
LevelNumber
ProgressNumber
GoalNumber
Total PointsNumber
Properties
Only On Level Up
Only fire when the train reaches a new level. Default off.

With Only On Level Up on, the first progress event of each train always counts as a level up.

Hype Train End

Fires when a hype train ends.

Hype Train EndTriggeredFinal LevelTotal Points
Outputs
TriggeredFlow
Final LevelNumber
Total PointsNumber

Channel points

Channel Point Redemption

Fires when someone redeems a channel point reward.

Channel Point RedemptionTriggeredUser NameReward TitleReward IDPoint CostUser Input
Outputs
TriggeredFlow
User NameString
Reward TitleString
Reward IDString
Point CostNumber
User InputString
The text the viewer entered, for rewards that ask for it.
Properties
Reward Title Filter
Only fire for rewards whose title contains this text, ignoring capitalization. Empty fires for every reward.

This trigger fires for every matching redemption, whether or not the reward is enabled on the Channel Points page.

Set Redeem Enabled

Turns a channel point reward on or off on Twitch.

Set Redeem EnabledExecuteReward IDDoneSuccessErrorIs Enabled
Inputs
ExecuteFlow
Reward IDString
Overrides the Reward property when connected and not empty.
Outputs
DoneFlow
SuccessBoolean
ErrorString
Is EnabledBoolean
True when the reward is now available to viewers.
Properties
Reward
The reward to control.
Action
Enable, Disable, or Toggle. Default Enable.

Disable pauses the reward on Twitch, and Enable unpauses it. Twitch only lets MultiShock change rewards it created, so create the reward from the Channel Points page with Create New Reward first. The Reward list shows "Loading rewards..." until the node has run once since MultiShock started; you can also connect a Reward ID instead.

Set Config Redeem Enabled

Turns a reward's local device action on the Channel Points page on or off. This does not pause the reward on Twitch.

Set Config Redeem EnabledExecuteReward IDDoneSuccessErrorIs Enabled
Inputs
ExecuteFlow
Reward IDString
Overrides the Reward property when connected and not empty.
Outputs
DoneFlow
SuccessBoolean
ErrorString
Is EnabledBoolean
Properties
Reward
A reward saved on the Channel Points page.
Action
Enable, Disable, or Toggle. Default Enable.

The reward must already be in the plugin's configuration; use Fetch Rewards first. The Channel Points master switch still controls whether local actions run. See configuring redeems.

Chat

Twitch Chat Message

Fires for messages in your channel's chat.

Twitch Chat MessageTriggeredUser NameUser IDMessageDisplay NameIs ModeratorIs SubscriberIs VIP
Outputs
TriggeredFlow
User NameString
The sender's login name.
User IDString
MessageString
Display NameString
Is ModeratorBoolean
Is SubscriberBoolean
Is VIPBoolean
Properties
Filter Text (optional)
Only fire for messages that contain this text.
Case Sensitive
Match Filter Text's capitalization exactly. Default off.

The moderator, subscriber, and VIP flags come from the sender's chat badges, so your own messages read Is Moderator false. The trigger doesn't skip any sender; if a flow replies with Send Chat Message, add a condition so it can't respond to its own messages.

Send Chat Message

Posts a message in your channel's chat as your account.

Send Chat MessageExecuteMessageDoneSuccessError
Inputs
ExecuteFlow
MessageString
Overrides the property when connected and not empty.
Outputs
DoneFlow
SuccessBoolean
ErrorString
Properties
Message
The message to send. Can span several lines.

Use Format String to build messages that include values such as a viewer's name.

Contributors

Thank you to everyone who has helped improve this documentation.