Set Overlay Variable
Runs on: Backend — writes an overlay variable and pushes it to the live overlay socket.
The Set Overlay Variable effect lets your flow update a variable that lives inside one of your overlays. Pick the target overlay and the variable you want to change from the dropdowns, then connect any matching value to the Value input. When the flow runs, the new value is saved to the database and immediately broadcast to any overlay client that is currently displaying that overlay — your viewers see the change in real time without a page reload.
The type of value accepted by the Value handle adjusts automatically based on the variable you select. Choosing a number variable causes the handle to expect a number; choosing a text variable expects a string, and so on. If you change the variable selection, any existing connection on the Value handle is removed so you can connect the correct type.
Inputs
| Name | Type | Description |
|---|---|---|
value | string, number, or boolean | The new value to write into the selected overlay variable. The accepted type matches the variable's configured type. |
Configuration
- Overlay: The overlay that owns the variable you want to update.
- Variable: The specific variable within the chosen overlay to overwrite.
Example
You have a "Top Donor" text widget on your overlay backed by a variable called top_donor_name. When a Channel Point Redeem fires, a flow reads the redeemer's name and connects it to a Set Overlay Variable effect targeting top_donor_name. The overlay label updates instantly for every viewer watching the stream.