Skip to main content

Flow Alert

Runs on: Backend — sends the alert to your overlay on the alert queue.

The Flow Alert effect displays an alert you designed yourself, carrying whatever fields you want, on a widget you choose.

Use it for anything the built-in alert types do not cover: a milestone celebration, a game score, a poll result, a chat command response.

Flow Alerts are alerts, so they queue. One finishes before the next begins, and a Flow Alert waits its turn behind a subscription or raid alert just like any other. If you want something that fires immediately and can overlap what is already on screen, use Flow Event instead.

How it works​

The widget owns the design, and the flow fills it in.

  1. Add a Flow Alert Widget to an overlay and give it a name.
  2. On that widget, declare the parameters it expects — a name and a type for each, like winner (Text) or score (Number).
  3. In your flow, add a Flow Alert effect and pick that widget from the Alert dropdown.
  4. The node grows one input per parameter the widget declared. Wire them up.
  5. Inside the widget, bind text, images and colours to {{flowAlert.winner}}, {{flowAlert.score}} and so on. Those tokens appear in the overlay editor's variable picker automatically, so you do not have to remember what you named them.

Because the widget declares the fields, the node and the overlay can never disagree about what they are called.

Choosing where it fires​

The Alert dropdown lists every Flow Alert widget across your overlays, shown as Overlay › Name.

Both halves are the address. The same name on two overlays is two separate targets, and duplicating an overlay produces a new target rather than silently inheriting the old one. Deleting or renaming the widget makes the node show the problem instead of quietly doing nothing.

Several widgets on the same overlay can share a name — all of them fire, and the alert finishes when they all have.

Inputs​

NameTypeDescription
ActivateanyFires the alert.
(one per parameter)matches the parameter's typeThe value for that field. Every parameter is optional — firing on Activate alone is fine.
Hold secondsnumberOptional. Overrides how long the alert stays on screen, and therefore how long the next alert waits. Leave it unconnected to use the widget's own Hold setting.

Example​

Celebrate a personal best. A chat command trigger feeds a Flow Alert effect pointed at a "Personal Best" widget on your gameplay overlay, which declares two parameters: game (Text) and time (Text). Inside the widget, a Text child is bound to {{flowAlert.game}} and another to {{flowAlert.time}}. The alert animates in, holds, and animates out — and anything else queued behind it waits politely.

See Also​