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

Song request

Add a song or search query to the song request queue. This works even if the public !sr chat command is disabled.

action.song_request · 2.8.0

Browse all entries

Requirements and availability

Song request playback/queue configuration and supported media source.

Picker contexts: automation, timer, command, pad.

Behavior

Run registered !sr as an automation actor, even when the public command is disabled. Blank query falls back to event input/message. Responses are suppressed unless sendResponse is true; the default response uses captured command output.

Configure in the app

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

Steps

Choose action category Music Controls, select Song request, 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
Song or search text `query`	textarea	Editor defaults: {"automation":"{message}","timer":"","command":"{message}","pad":""} Example hint: Never Gonna Give You Up, a YouTube URL, or {message}	Supports variables
Platform `platform`	select Same platform as event: event Twitch + YouTube + Kick: all Twitch: twitch YouTube: youtube Kick: kick TikTok: tiktok	Editor defaults: {"automation":"event","timer":"all","command":"event","pad":"all"}	Literal value / selected resource
Send chat response `sendResponse`	checkbox	Declared UI default: `false` Editor defaults: {"automation":false,"timer":false,"command":false,"pad":false}	Literal value / selected resource
Response `response`	textarea	Declared UI default: `@{user} — "{title}" by {artist} added to the queue!` Editor defaults: {"automation":"@{user} — \"{title}\" by {artist} added to the queue!","timer":"@{user} — \"{title}\" by {artist} added to the queue!","command":"@{user} — \"{title}\" by {artist} added to the queue!","pad":"@{user} — \"{title}\" by {artist} added to the queue!"} Example hint: @{user} — "{title}" by {artist} added to the queue!	Supports variables

Contract details

Declared Contexts: [ "timer", "automation" ]
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.

{
  "query": "Example song",
  "platform": "twitch",
  "sendResponse": false
}

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

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1