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 Marketplace Widget

Send a button/action event to a Marketplace Item widget in Overlay Builder.

action.trigger_marketplace_widget · 2.8.0

Browse all entries

Requirements and availability

Installed active Marketplace widget, placed surface and its declared action contract.

Picker contexts: automation, timer, command, pad.

Behavior

Resolve buttonKey (runtime blank fallback run; editor initializes spinWheel) and payloadJson. Invalid JSON becomes a message payload rather than a parse failure. Target actions must exist on the installed widget.

Configure in the app

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

Steps

Choose action category Overlay Widgets, select Trigger Marketplace Widget, 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

Field	Input / options	Defaults / limits	Availability
Marketplace widget `widgetTarget`	theme_select Options: overlay_builder.marketplace_widgets	Editor defaults: {"automation":"","timer":"","command":"","pad":""}	Literal value / selected resource
Widget action `buttonKey`	text	Declared UI default: `spinWheel` Editor defaults: {"automation":"spinWheel","timer":"spinWheel","command":"spinWheel","pad":"spinWheel"} Example hint: spinWheel	Supports variables
Payload JSON `payloadJson`	textarea	Declared UI default: Editor defaults: {"automation":"","timer":"","command":"","pad":""} Example hint: {"source":"channel-point"}	Supports variables

Marketplace widget
widgetTarget

theme_select

Options: overlay_builder.marketplace_widgets

Editor defaults: {"automation":"","timer":"","command":"","pad":""}

Literal value / selected resource

Widget action
buttonKey

text

Declared UI default: spinWheel

Editor defaults: {"automation":"spinWheel","timer":"spinWheel","command":"spinWheel","pad":"spinWheel"}

Example hint: spinWheel

Supports variables

Payload JSON
payloadJson

textarea

Declared UI default:

Editor defaults: {"automation":"","timer":"","command":"","pad":""}

Example hint: {"source":"channel-point"}

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.

{
  "widgetTarget": "fixture-widget",
  "buttonKey": "run",
  "payloadJson": "{}"
}

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

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1