Beta reference. Prepared from development builds for this version. This reference does not describe the current stable release.

A verified stable reference is not available yet. Choose a prepared beta version above.

Do · Actions · supported

Trigger Alert

Send an alert payload to Overlay Builder Alert Box widgets. Event variables from raids, subs, follows, cheers, and custom triggers can be used in the text fields.

action.trigger_alert · 2.8.0

Browse all entries

Requirements and availability

Saved Alert Box preset/placement and running Overlay Builder browser source.

Picker contexts: automation, timer, command, pad.

Behavior

Resolve title/message, then dispatch to Alert Box placements using selected overlay/preset/media. Blank resource values allow downstream preset/default resolution. Duration is milliseconds; do not treat seconds as milliseconds.

Configure in the app

Open: Do → Advanced Actions (commands only) → Add action

Steps

Choose action category Send to Overlay, select Trigger Alert, and click Add action.
Expand the action card. Configure the Fields below; check Editor defaults for your context and any operation-dependent fields.
Choose resource values from real app pickers. Set output Platform separately from the trigger Where setting when the action offers it.
Use Move action up / Move action down to position this action, then save the containing command, automation, timer or SheevPad button.

Limitations

Picker availability does not supply missing event variables. Check prerequisites and originating provider.
An action return value is not automatically a sequence variable. Only documented producers create template outputs.

Fields

Field	Input / options	Defaults / limits	Availability
Overlay source `overlaySlug`	theme_select Options: overlay_builder.overlays	Editor defaults: {"automation":"","timer":"","command":"","pad":""}	Literal value / selected resource
Alert preset `presetId`	theme_select Options: alert_presets.local	Editor defaults: {"automation":"","timer":"","command":"","pad":""}	Literal value / selected resource
Alert context `alertType`	select Custom: custom Follow: follow Subscription: sub Gift sub: gift_sub Raid: raid Bits / KICKs: cheer	Declared UI default: `custom` Editor defaults: {"automation":"custom","timer":"custom","command":"custom","pad":"custom"}	Literal value / selected resource
Title `title`	text	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Example hint: Alert	Supports variables
Message `message`	textarea	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Example hint: {user} triggered an alert!	Supports variables
Visual media `mediaId`	media_select	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Media Types: image,gif,video	Literal value / selected resource
Sound `soundId`	media_select	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Media Types: audio	Literal value / selected resource
Duration (ms) `durationMs`	number	Declared UI default: `8000` Editor defaults: {"automation":8000,"timer":8000,"command":8000,"pad":8000} Min: 1000 Max: 60000	Literal value / selected resource

Contract details

Declared Contexts: [ "timer", "automation", "command", "pad" ]
Picker Contexts: [ "automation", "timer", "command", "pad" ]
Hidden From Picker: false
Required Variables: []
Failure Behavior: See the behavior for local skips/errors and context entries for sequence continuation.
Outputs: []

Examples

Illustrative configuration; replace fixture resources in the editor. This is not an import file.

{
  "overlaySlug": "fixture-overlay",
  "presetId": "fixture-alert",
  "title": "Hello",
  "message": "Welcome {user}!",
  "durationMs": 8000
}

Related entries

Source and verification

Source-reviewed for 2.8.0. Connected-service validation remains subject to release UAT.

src/features/automations.js — ACTION_REGISTRY.trigger_alert
public/index.html — getBuilderActionEntries / createDefaultAction

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1