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

Run Streamer.bot Action

Runs a Streamer.bot action through a local WebSocket connection. Used by Streamer.bot command migration.

action.streamerbot_action · 2.8.0

Browse all entries

Requirements and availability

Streamer.bot WebSocket server enabled and a valid action ID/name.

Picker contexts: automation, timer, command, pad.

Behavior

Run a Streamer.bot action over local WebSocket, preferring actionId with actionName fallback. argsJson resolves through the global variable engine and must parse as JSON; simple event substitution is only a resolver-error fallback. User/username/platform/message arguments are supplied and can be overridden by parsed args. Host/port defaults are 127.0.0.1:8080.

Configure in the app

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

Steps

Choose action category Utilities, select Run Streamer.bot Action, 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
Host `host`	text	Declared UI default: `127.0.0.1` Editor defaults: {"automation":"127.0.0.1","timer":"127.0.0.1","command":"127.0.0.1","pad":"127.0.0.1"} Example hint: 127.0.0.1	Literal value / selected resource
Port `port`	number	Declared UI default: `8080` Editor defaults: {"automation":8080,"timer":8080,"command":8080,"pad":8080} Min: 1 Max: 65535	Literal value / selected resource
Action ID `actionId`	text	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Example hint: Preferred when available	Literal value / selected resource
Action Name `actionName`	text	Editor defaults: {"automation":"","timer":"","command":"","pad":""} Example hint: Fallback if ID is not available	Literal value / selected resource
Arguments JSON `argsJson`	textarea	Editor defaults: {"automation":"{}","timer":"{}","command":"{}","pad":"{}"} Example hint: {"user":"{user}","platform":"{platform}"}	Supports variables

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.

{
  "host": "127.0.0.1",
  "port": 8080,
  "actionId": "fixture-action",
  "argsJson": "{}"
}

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

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1