OverlayThing Docs
Home
Login / Request Access
01 Get started
Introduction Quickstart Add to your stream
02 Overlays
Overlays The editor Overlay URLs Alert queue Share, export & import
02.1 Widgets
Widgets overview Alerts Variations Hype Train Text to speech Goals Countdown & subathon Chat box Data labels Counter Text, image & video
03 Chatbot
Chatbot overview Getting started Commands Variables Conditionals Recipes API commands Integrations Command API & Copy-URL Chat moderation Bot account Bot settings
03.1 Chatbot modules
Modules overview Timers Counters Quotes Chat alerts Welcome Ad Breaks Giveaways Queue Song requests Loyalty
04 Flows
Overview Build a flow Triggers Conditions Actions Using data Examples
05 Remote Control
Overview Connect OBS Studio Connect Meld Studio Bindings & triggers Security & access
06 Companion
Companion overview Install & pair Feed, chat & channel Scripting The scripting API Permissions & security
07 Monetize
Tip page Tip settings Merch with Fourthwall
08 Build your own
AI Magic Builder Custom widgets Widget SDK
09 Your data
Dashboard Stream data Chat log Moderation
10 Account
Settings & connections Export your data Import from StreamElements
11 Reference
Label tokens Keyboard shortcuts FAQ Troubleshooting
Flows/Triggers
Flows

Triggers.

A trigger is the event that starts a flow. Every flow has at least one. Most triggers can be narrowed to exactly what you care about, so a reward trigger can fire for one specific reward, and a keyword trigger can fire only on the words you choose.

Every trigger

Triggers cover the things that happen on your channel, your chat, your modules and your moderation. Here is the full menu, grouped the way it appears when you add a trigger node:

Subs & bits
Someone followsFires when a viewer follows the channel.
Someone subscribesFires on any subscription (new, resub, gift, Prime, and more).
Someone cheers bitsFires when a viewer cheers bits in chat.
Someone tipsFires on a tip (our own PayPal IPN, normalized to USD).
Someone buys merchFires when a viewer buys merch (Fourthwall).
A subscription endedFires when a subscription lapses (bookkeeping, never a celebration).
Someone reaches a new bits badge tierFires when a viewer crosses a new Bits badge tier threshold.
Raids & shoutouts
Someone raids youFires when another streamer raids the channel.
You receive a shoutoutFires when a moderator gives a shoutout to another channel.
Stream
A clip is createdFires when a clip of your stream is created, by anyone.
Title or category changesFires when the stream title, category, or language changes.
Stream goes liveFires when the channel goes live.
Stream goes offlineFires when the channel goes offline.
An ad break beginsFires when an ad break starts.
An ad break endsFires when an ad break finishes.
On a scheduleFires at a time you set, optionally limited to certain days or only while live.
Channel points
A reward is redeemedFires when a viewer redeems a channel-point reward.
A Power-up is usedFires when a viewer uses a Twitch Power-up (Gigantify an Emote, Celebration, Message Effect).
Giveaways
A giveaway winner is drawnFires when a giveaway winner is revealed.
A giveaway startsFires when a giveaway opens for entries.
Someone enters the giveawayFires when a viewer enters the running giveaway.
Hype train
Hype train starts or levels upFires when a hype train begins or reaches a new level.
Hype train endsFires when a hype train finishes.
Polls & predictions
A poll endsFires when a Twitch poll finishes (completed, ended early, or archived).
A prediction endsFires when a Twitch prediction resolves or is canceled.
Chat
Someone sends a messageFires on every chat message.
Someone hits a watch streakFires when a viewer reaches a Watch Streak milestone (consecutive streams watched).
A message matches a keywordFires when a chat message contains a keyword or phrase (or matches a regular expression).
A first-time chatter speaksFires the first time a viewer ever sends a message.
A returning regular speaksFires when a known regular sends their first message of the stream.
A command is usedFires when one of your chat commands is run.
Moderation
A message is deletedFires when a moderator deletes a single chat message.
A user's messages are clearedFires when a user's messages are cleared (timeout or ban, undifferentiated).
A user is timed outFires when a moderator times out a user.
A user is bannedFires when a moderator bans a user.
A user is unbannedFires when a moderator removes a ban.
A user is warnedFires when a moderator warns a user.
AutoMod holds a messageFires when AutoMod holds a message for review.
A held message is resolvedFires when an AutoMod-held message is approved or denied.
Counters
A counter changesFires when a counter value changes.
Queue
Someone joins the queueFires when a viewer joins the queue.
Someone leaves the queueFires when a viewer leaves the queue.
The next viewer is brought upFires when the next person in the queue is pulled up.
Media requests
A song is requestedFires when a viewer requests a song.
A song startsFires when a requested song starts playing.
A song is skippedFires when a song is skipped.
A song finishesFires when a requested song finishes playing.
Timers
A timer firesFires when one of your chat timers posts.
Goals
A goal makes progressFires when a goal advances toward its target.
A goal is reachedFires when a goal hits its target.
Welcome
Someone is greetedFires when the welcome module greets a chatter.
Watchable values
A value crosses a thresholdFires once when a watchable value crosses a threshold (a counter reaches N, hype reaches a level, uptime passes a time, the subathon clock drops below a time).
Chat velocity spikesFires when a burst of chat messages arrives within a time window.
Flows
A custom event firesFires when another flow emits a named custom event via the "Emit a custom event" action.

Narrowing a trigger

Most triggers have a filter so the flow only runs for the case you want. A few examples:

  • A reward is redeemed lets you pick one reward, or "Any reward" to fire on all of them.
  • A message matches a keyword lets you match a word or phrase, or switch to a regular expression for precise matching. The Regex Assist helper can write the expression for you.
  • A command is used lets you pick which of your commands fires the flow.
  • A subscription can be limited to a tier, a gift, or a resub.
One flow can watch more than one thing

You can put more than one trigger in a single flow. Each trigger only starts its own branch, so a flow with a chat trigger and a song trigger keeps the two paths separate.

Built-in rewards and Power-ups

Twitch has two kinds of channel-point reward: the custom ones you create, and the built-in ones (Highlight My Message, Unlock an Emote, and so on) plus Power-ups. The reward trigger lists your custom rewards next to the built-in ones, so you can flow off either. Power-ups (Gigantify an Emote, Celebration, Message Effect) have their own trigger.

Built-in rewards have no listed cost

Twitch does not share the price of the built-in rewards with apps ahead of time, so only your custom rewards show a point cost in the picker.

Newer triggers

Chat velocity spikes fires on a burst of messages inside a rolling window, and can optionally count only messages that contain some text or match a regex. It carries a messages list, each entry with the message text, the chatter's login, their display name and their id, so you can reference the first, the last, a random one, or join them together.

On a schedule fires at a time of day you set. Limit it to weekdays, or to only while you are live, and it reads the clock in your Bot Settings timezone.

A value crosses a threshold fires once, the moment a tracked value crosses a line you set. See Watchables below for what you can track.

A custom event fires fires when another flow runs the "Emit a custom event" action with a matching name, so you can pair two flows together. Leave the name blank to match any custom event.

Values you can watch

The threshold trigger works off a fixed set of values the platform tracks for you:

ValueExample
Counter's valueWhen deaths reaches 100.
Hype train levelWhen the train reaches level 3.
Stream uptimeWhen uptime passes 2h.
Viewer countWhen viewers rise above 500.
Goal progressWhen the follower goal reaches 75%.
Subathon time remainingWhen it drops below 5m.
Queue lengthWhen the queue reaches 10.
Giveaway entriesWhen entries reach 100.
Previous Build a flow Next Conditions
On this page
Ask the docs
Have a question?
Thinking it through...
Answer
Get an answer instantly; our model is trained on every feature of our streaming suite.
ESC
Get started
More than overlaysOverlayThing is an all-in-one toolkit for your Twitch channel: a visual overlay … Get started From zero to liveThe fastest path to a working overlay on your stream. Sign in, build something, … Get started Add to your streamOne overlay, one URL, one browser source. OverlayThing works with any streaming … Get started
Overlays
OverlaysYour overlays live on the Overlays page, a gallery of every canvas you have buil… Overlays The editorWhere overlays are built. A canvas in the middle, your layer stack on the left, … Overlays Overlay URLsEach overlay has its own private URL. Add it to your streaming software once and… Overlays Alert queueWhen events pile up (a gifted-sub train, a hype raid), you usually want alerts t… Overlays Share, export & importMove overlays and individual widgets between your own overlays, back them up as … Overlays
Widgets
Widgets overviewWidgets are the building blocks of an overlay. Some fire on an event and leave (… Widgets AlertsThe moment something happens, an alert fires on screen with motion, sound and yo… Widgets VariationsOne event, different reactions. Variations let a single alert play a bigger vers… Widgets Hype TrainWhen a Hype Train rolls on your channel, OverlayThing can fire an on-screen aler… Widgets Text to speechHave alerts read messages aloud: a tip note, a resub message, a redemption. Text… Widgets GoalsA progress bar with a target. It fills itself as events come in, and you can cel… Widgets Countdown & subathonTwo timer widgets. A countdown runs down to a time or for a set duration. A suba… Widgets Chat boxPut your Twitch chat on stream, great for handheld, IRL or face-cam layouts wher… Widgets Data labelsSmall live readouts that keep your channel numbers on screen: latest follower, l… Widgets CounterPut a live number on your overlay: deaths, wins, fails, anything you keep a runn… Widgets Text, image & videoThe plain building blocks. Use them for backgrounds, frames, logos, panels and l… Widgets
Chatbot
The chatbotA Twitch chat bot built into OverlayThing: custom commands, timers, counters, qu… Chatbot Getting startedTurn the bot on, make it a moderator, and pick your command prefix. Three small … Chatbot CommandsCommands are the heart of the bot. A viewer types a trigger, the bot replies wit… Chatbot VariablesVariables are $( … ) tokens you drop into a command response. They fill in with … Chatbot ConditionalsConditionals let one command react differently to different viewers and situatio… Chatbot RecipesCopy-ready command responses for the trickier variables: shoutouts, weather, dic… Chatbot API commandsPower-user territory. Wire a command to an external API and pull a live value in… Chatbot IntegrationsBuilt-in connections to outside services that add ready-made variables. Today th… Chatbot Command API & Copy-URLFire bot commands and module actions from outside chat: a Stream Deck button, a … Chatbot Chat moderationWhen the bot is a moderator it can keep chat clean automatically: tunable spam f… Chatbot Bot accountChoose which Twitch account the bot posts as: the shared OverlayThing bot, your … Chatbot Bot settingsThe channel-wide behavior of the bot: your prefix, how it replies, how cooldowns… Chatbot
Chatbot modules
ModulesThe bot is built from modules you switch on one at a time. Turn on only what you… Chatbot modules TimersPost recurring messages on a schedule: rules, your socials, a sponsor plug. Time… Chatbot modules CountersTrack a number from chat: deaths, wins, fails, anything you want to tally live.… Chatbot modules QuotesA searchable quote book your chat builds with you, one memorable line at a time.… Chatbot modules Chat alertsPost a chat message when someone follows, subscribes, resubs, gifts, cheers or r… Chatbot modules WelcomeGreet people automatically: first-time chatters, returning regulars, and incomin… Chatbot modules Ad BreaksHave the bot speak up around your ad breaks: a heads-up before they hit, a line … Chatbot modules GiveawaysRun a giveaway and draw a winner from chat, by keyword entry or passive presence… Chatbot modules QueueLet viewers line up to play with you. They join, you pull people up in order.… Chatbot modules Song requestsViewers request YouTube songs by name or link and the bot builds a play queue, w… Chatbot modules LoyaltyTrack how long your viewers watch, so you can spot and reward your most loyal re… Chatbot modules
Flows
FlowsFlows let you wire your channel together with no code. Pick something that happe… Flows Build a flowYou build a flow on a canvas: add nodes, connect them in the order they should r… Flows TriggersA trigger is the event that starts a flow. Every flow has at least one. Most tri… Flows ConditionsConditions are the rules in a flow. They decide whether the run keeps going and … Flows ActionsActions are the things a flow does. Most of what the rest of the platform can do… Flows Using dataThe best flows feel personal because they use the real details of the event. Dro… Flows ExamplesFour flows from simple to advanced, drawn as the real graphs you build on the ca… Flows
Remote Control
Remote ControlDrive your local OBS Studio or Meld Studio straight from OverlayThing. Switch sc… Remote Control Connect OBS StudioAdd the Remote Control URL as a dock or browser source, enable the OBS WebSocket… Remote Control Connect Meld StudioAdd the blank Remote Control source to every Meld scene. There is no password to… Remote Control Bindings & triggersA binding is one or more actions plus the trigger that fires them. Build them on… Remote Control Security & accessThe Remote Control URL is a key to your streaming software, and your OBS passwor… Remote Control
Companion
CompanionA native desktop app for macOS and Windows that pairs with your OverlayThing acc… Companion Install & pairDownload the Companion for your operating system, open it, and approve one short… Companion Feed, chat & channelThe Companion mirrors the parts of your dashboard you touch mid-stream, on your … Companion ScriptingWrite small scripts that react to your stream and do things only a local app can… Companion The scripting APIThe complete ot surface: every event you can listen to, every action you can tak… Companion Permissions & securityScripts run in a sandbox and start with zero powers. You grant each capability p… Companion
Monetize
Your tip pageA branded donation page viewers can reach from a single link in your panels or c… Monetize Tip settingsEverything behind your tip page: the payment connection, your branding, the amou… Monetize Merch with FourthwallConnect your Fourthwall shop and merch sales fire alerts on stream, the same way… Monetize
Build your own
AI Magic BuilderDescribe the widget you want in plain language and OverlayThing builds a styled,… Build your own Custom widgetsFor when you want to break the mold. Write your own HTML, CSS and JavaScript, re… Build your own Widget SDKThe API your custom widgets use to receive live events and persist state. It is … Build your own
Your data
DashboardYour home base. The numbers that matter at a glance, a chart to spot trends, and… Your data Stream dataThe numbers behind your overlay. Labels, goals and leaderboards all read from he… Your data Chat logA searchable archive of your chat, events and moderation actions. Look up what a… Your data ModerationEvery chat message, tip note and alert message runs through a moderation pipelin… Your data
Account
Settings & connectionsYour account, your connected services, and the controls that protect your access… Account Export your dataYour data is yours. From Settings, under Data and privacy, you can take it with … Account Import from StreamElementsAlready set up elsewhere? Bring your overlays, alert settings, goals and history… Account
Reference
Label tokensTokens are {placeholders} you drop into alert text, label templates and goal lab… Reference Keyboard shortcutsThe editor is built for the keyboard. These are the ones worth learning.… Reference FAQShort answers to the questions we hear most. For step-by-step fixes when somethi… Reference TroubleshootingQuick fixes for the things that trip people up most.… Reference
↑↓ navigate ⏎ open esc close