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

Send Text Payload

Send a generic text payload to overlay widgets. Useful for custom widgets that display queue, prompt, or status text.

action.send_overlay_text · 2.8.0

Browse all entries

Requirements and availability

A running compatible overlay receiver subscribed to the selected routing channel.

Picker contexts: automation, timer, command, pad.

Behavior

Resolve text; blank does nothing. Publish to receivers using targetMode (default broadcast), channel (text), selected overlay/widget, priority and TTL.

Configure in the app

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

Steps

Choose action category Send to Overlay, select Send Text Payload, 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
Text `text`	textarea	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null} Example hint: Overlay message with {variables}	Supports variables
Payload channel `channel`	select TTS: tts Audio: audio Text: text Default: default Alerts: alerts	Declared UI default: `text` Editor defaults: {"automation":"text","timer":"text","command":"text","pad":"text"}	Literal value / selected resource
Send to `targetMode`	select All listening overlay widgets: broadcast Specific overlay: overlay Specific widget: widget Matching channel only: channel	Declared UI default: `broadcast` Editor defaults: {"automation":"broadcast","timer":"broadcast","command":"broadcast","pad":"broadcast"}	Literal value / selected resource
Overlay `overlaySlug`	theme_select Options: overlay_builder.overlays	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null}	Literal value / selected resource Shown when: {"targetMode":"overlay"}
Widget ID `widgetId`	text	Editor defaults: {"automation":null,"timer":null,"command":null,"pad":null} Example hint: overlay widget id	Literal value / selected resource Shown when: {"targetMode":"widget"}
Priority `priority`	number	Declared UI default: `0` Editor defaults: {"automation":0,"timer":0,"command":0,"pad":0} Min: 0 Max: 100	Literal value / selected resource
Expires after (ms) `ttlMs`	number	Declared UI default: `300000` Editor defaults: {"automation":300000,"timer":300000,"command":300000,"pad":300000} Min: 1000 Max: 3600000	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.

{
  "text": "Community night",
  "targetMode": "broadcast",
  "channel": "text",
  "priority": 0,
  "ttlMs": 300000
}

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.send_overlay_text
public/index.html — getBuilderActionEntries / createDefaultAction

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1