Skip to Content
NexmodAlerts

Alerts

Alerts are visual and audio notifications that display on your stream overlay when events happen — follows, subscriptions, cheers, raids, donations, and custom triggers.

Custom alerts are available on Plus plans and above.

How Alerts Work

  1. An event occurs (follow, sub, raid, etc.)
  2. Nexmod creates an alert entry in the queue
  3. Your stream overlay fetches pending alerts
  4. The alert displays with your configured template (text, image, sound, animation)
  5. The alert is marked as played

Alert Types

TypeTrigger
FollowA new viewer follows
SubscriptionA viewer subscribes or resubscribes
CheerA viewer cheers with bits
RaidAnother streamer raids your channel
DonationA donation is received from a third-party platform
CustomTriggered manually or by an action

Alert Templates

Templates define how alerts look and sound. Each template is tied to an alert type and includes:

PropertyDescriptionDefault
NameTemplate identifierRequired
TypeWhich alert type this template is forRequired
EnabledToggle the template on or offtrue
DurationHow long the alert displays (ms)5000
LayoutJSON layout configuration{}
Text TemplateDynamic text with variables""
Image URLImage to display with the alert
Sound URLSound to play when the alert fires
Animation InEntry animationfadeIn
Animation OutExit animationfadeOut
Custom CSSOverride styles for this template

Alert Queue

Alerts are queued and played in order. The dashboard provides controls for:

  • Pending alerts — View alerts waiting to be played
  • History — See past alerts and when they played
  • Mark as played — Manually dismiss an alert
  • Clear queue — Remove all pending alerts

Dashboard Permissions

ActionRequired Permission
View alerts and templatesalerts:read — Viewer and above
Create, edit, delete templates and manage queuealerts:manage — Moderator and above
Last updated on