Edit

Twitch

SAMMI can listen to Twitch events and automatically execute your buttons. For example, it can automatically trigger a button every time you get a new subscriber.

Add a new trigger #

  1. Right click on a button in SAMMI - Edit Triggers (or CTRL + double click).
  2. Click on the + button and select the Twitch trigger type.
  3. Fill out the fields and options for the selected trigger (read below) and press Save.
  4. Optionally you can right click on a button - Edit Settings and check Add to Request Queue, which acts as a button queue. If there is another trigger event while the button is still active (for example if you get two subscribers at the same time), it will place is in the queue and reactivate the button as soon as it’s ready again.
  5. In your button commands, use Trigger Pull Data command to retrieve all the provided information from the event (viewer’s name, their message, emotes, badge etc.).

Trigger Types #

Chat #

Listens to all chat messages and triggers when specific conditions are met.
The message field comes with a prefilled *, which means it will allow ALL chat messages to come through. You can delete the * and use your own keyword.

Condition Explanation
Mod Triggers only if a mod sends the message.
Sub Triggers only if a subscriber sends the message.
Broadcaster Triggers only if the broadcast themselves sends the message.
VIP Triggers only if a VIP viewer sends the message.
Founder Triggers only if the viewer has founders badge.
Message Chat message to listen to. Must be an exact match. Can include Wild Cards.
Case Sensitive If the user message trigger should be case sensitive
Pull Data Value Explanation
User Name Viewer’s username (all lowercase characters).
Display Name Viewer’s display name (can contain uppercase characters).
User ID Viewer’s user ID.
Message Viewer’s message.
Emote List Viewer’s available emotes.
Basic format: FirstEmoteID:FirstIndex-LastIndex/ SecondEmoteID:FirstIndex-LastIndex
Message containing multiple emotes will be formatted such as: FirstEmoteID:FirstIndex(1)-LastIndex(1),FirstIndex(2)-LastIndex(2),FirstIndex(3)-LastIndex(3)
Chat Emotes List
Badge List Basic format: FirstBadgeName/version,SecondBadgeName/version
For example: broadcaster/1, subscriber/0
Global Badges List, Channel Badges List
To find the badge ID in the JSON, look for BadgeList.badge_sets[BADGENAME].versions[VERSION].image_url_1x. The last part 1x can be changed to 2x, 3x or 4x for bigger size.
Channel Channel Name where the message originated from. Will return w if it’s a whisper.
Name Color Chat name color in hexadecimal format.
First Time Whether it’s user’s first chat message. 0 = not first, 1 = first
From Channel ID Which channel the trigger came from.

Whispers #

Triggers for any new received whisper messages. Must use Twitch Open Whispers command to enable whisper messages.

Condition Explanation
Message Whisper message to listen to. Must be an exact match. Can include Wild Cards.
Case Sensitive If the user message trigger should be case sensitive
Allow Empty Wildcard Check to allow empty strings as valid results
Sent Messages Whether you want the button to trigger for not only received, but also sent messages
Pull Data Value Explanation
Sender User Name Username of the user who sent the whisper.
Sender Display Name Display Name of the user who sent the whisper.
Sender User ID User ID of the user who sent the whisper.
Sender Color Color of the user who sent the whisper.
Recipient User Name Username of the user who received the whisper.
Recipient Display Name UsDisplay Namername of the user who received the whisper
Recipient User ID User ID of the user who received the whisper
Recipient Color Color of the user who received the whisper
Message Received message.
Sent Sent message
Emote List Sender’s available emotes.
Basic format: FirstEmoteID:FirstIndex-LastIndex/ SecondEmoteID:FirstIndex-LastIndex
Message containing multiple emotes will be formatted such as: FirstEmoteID:FirstIndex(1)-LastIndex(1),FirstIndex(2)-LastIndex(2),FirstIndex(3)-LastIndex(3)
Chat Emotes List
Badge List Basic format: FirstBadgeName/version,SecondBadgeName/version
For example: broadcaster/1, subscriber/0
Global Badges List, Channel Badges List
To find the badge ID in the JSON, look for BadgeList.badge_sets[BADGENAME].versions[VERSION].image_url_1x. The last part 1x can be changed to 2x, 3x or 4x for bigger size.

New Follower #

Triggers for all new channel followers.

Pull Data Value Explanation
User Name Viewer’s username (all lowercase characters).
Display Name Viewer’s display name (can contain uppercase characters).
User ID Viewer’s user ID.
From Channel ID Which channel the trigger came from.

Subscription #

Listens to all new subscribers in your channel.

Condition Explanation
Tier 1 Triggers for tier 1 subscriptions.
Tier 2 Triggers for tier 2 subscriptions.
Tier 3 Triggers for tier 3 subscriptions.
Prime Triggers for prime subscriptions.
Normal Sub Triggers for regular subscriptions.
Sub Gift Triggers for non anonymous gifted subscriptions.
Anonymous Sub Gift Triggers for anonymous gifted subscriptions.
Allow Community Gifts Triggers for community gifted subscriptions
Month Range Minimum and maximum amount of months the user must be suscribed for the event to trigger.
Pull Data Value Explanation
User Name Viewer’s or gifter’s username (all lowercase characters).
Display Name Viewer’s or gifter’s display name (can contain uppercase characters).
User ID Viewer’s or gifter’s user ID.
Gifted User Name Recipient’s user name if the sub was gifted.
Gifted Display Name Recipient’s display name if the sub was gifted.
Gifted User ID Recipient’s user ID if the sub was gifted.
Tier Sub Tier. Returns Tier 1, Tier 2, Tier 3 or Prime
Context Sub Type. Returns sub, resub, subgift or anonsubgift
Message Viewer’s message
Month Amount of months the viewer has been subscribed
Community Gift Whether it’s a community gift. Boolean value. Returns 0 or 1.
From Channel ID Which channel the trigger came from.

Community Gift Subs #

Triggers for all community gift subscriptions.

Condition Explanation
Tier 1 Triggers for tier 1 gifted subscriptions.
Tier 2 Triggers for tier 2 gifted subscriptions.
Tier 3 Triggers for tier 3 gifted subscriptions.
Minimum Specify the minimum amount of gifted subs to trigger the button.
Maximum Specify the maximum amount of gifted subscribers to trigger the button.
Pull Data Value Explanation
User Name Gifter’s username. Returns ananonymousgifter for anonymous gifters.
Display Name Gifter’s display name. Returns AnAnonymousGifter for anonymous gifters.
User ID Gifter’s user ID.
Amount Amount of subs gifted.
Tier Sub Tier. Returns Tier 1, Tier 2, Tier 3 or Prime
From Channel ID Which channel the trigger came from.

Bits #

Listens to all bit events in your stream.

Condition Explanation
Minimum Specify the minimum amount of bits to trigger the button.
Maximum Specify the maximum amount of bits to trigger the button.
Pull Data Value Explanation
User Name Viewer’s username.
User ID Viewer’s user ID.
Amount Amount of bits donated.
Total Amount Amount of total bits donated.
Message Viewer’s message.
From Channel ID Which channel the trigger came from.

Raid #

Listens to all raid events in your stream.

Condition Explanation
Minimum Specify the minimum amount of raiders to trigger the button.
Maximum Specify the maximum amount of raiders to trigger the button.
Pull Data Value Explanation
User Name Raider’s username.
Display Name Raider’s or host’s display name.
User ID Raider’s user ID.
Amount Amount of raiders or host’s viewers.
From Channel ID Which channel the trigger came from.

Host #

Listens to all host events in your stream. Twitch does not send alerts for host events with less than three viewers.

Condition Explanation
Minimum Specify the minimum amount of host’s viewers to trigger the button.
Maximum Specify the maximum amount of host’s viewers to trigger the button.
Pull Data Value Explanation
Display Name Host’s display name.
Amount Amount of host’s viewers.
From Channel ID Which channel the trigger came from.

Channel Points #

Listens to all custom channel points redeems.

In order for SAMMI to listen to Channel Point triggers, make sure the scope to listen to Channel Points has been enabled in SAMMI. Twitch and the Bridge also has to be connected.

Condition Explanation
Redemption Name Select the name of the redemption from the list or type in manually. A single * allows all redeems to trigger the button (does not act as a wildcard).
User Input Required Whether the particular redemption requires viewers to enter text when redeemed
Case Sensitive If the user message trigger should be case sensitive
User Input User input if the redemption requires requires viewers to enter text when redeemed (use * to accept all user messages). Can include Wild Cards.
Allow Empty Wildcard Check to allow empty strings as valid results
Pull Data Value Explanation
User Name Viewer’s username.
Display Name Viewer’s display name.
User ID Viewer’s user ID.
Redeem Name Name of the reward redeemed.
Message Viewer’s redeem message if required.
Cost Reward cost.
Image Reward’s image URL. Returns default crystal ball if there’s no image.
Reward ID Reward’s general ID.
Redeem ID Redeem’s specific ID. Can be used to fulfill or cancel the redemption with Channel Points extension.
From Channel ID Which channel the trigger came from.

Prediction #

Triggers for all prediction events.

Condition Explanation
Type Type of the prediction event to trigger the button
Created = when a new prediction is created
Voted = when a current prediction receives a new vote,
Locked = when a current prediction ends and no more votes are accepted,
Resolved - when the broadcaster chooses an outcome for the prediction
Pull Data Value Explanation
Duration Duration of the prediction
Event  
Prediction Name Name of the prediction
Prediction ID Prediction unique ID
Vote Total Total prediction votes
Outcome 1 Info An object containing prediction’s outcome 1 information
Outcome 2 Info An object containing prediction’s outcome 2 information
Outcome x Info An object containing prediction’s outcome x information, up to 10
Winning Outcome Winning outcome
From Channel ID Which channel the trigger came from.

Poll #

Triggers for all poll events.

Condition Explanation
Type Type of the poll event to trigger the button
Created = when a new poll is created
Voted = when a current poll receives a new vote,
Ended = when a current poll ends and no more votes are accepted,
Archived - when a current poll is archived (and disappears from Twitch chat)
Pull Data Value Explanation
Choice Amount Number of poll choices
Duration Duration of the poll
Poll Name Name of the poll
Poll ID Poll unique ID
Vote Total Total poll votes
Vote Total Base Total base poll votes (no bits or points used)
Vote Total Bits Total bits poll votes
Vote Total Points Total channel points poll votes
Top Vote List Top vote user list
Choice 1 Info An object containing poll’s choice 1 information
Choice 2 Info An object containing poll’s choice 2 information
Choice 3 Info An object containing poll’s choice 3 information
Choice 4 Info An object containing poll’s choice 4 information
Choice 5 Info An object containing poll’s choice 5 information
From Channel ID Which channel the trigger came from.

Hype Train #

Triggers for all new hype train events.

Condition Explanation  
Type Dropdown Type of the hype train event to trigger the button
Approaching = when a new hype train is about to begin
Started = when a new hype train has started,
Conductor Update = when a hype train receives new points (for example if someone subscribes while it’s ongoing),
Level up - when a hype train levels up
Ended - when a hype train has ended,
Cooldown expired - when a previous hype train’s cooldown has expired and a new hype train can begin

Moderation #

Triggers for any of the selected moderation events. Due to some back-end changes from Twitch, listening to some moderation events currently do not work.

Condition Explanation  
Type Dropdown Type of the event to trigger the button