Skip to reference

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.

Invocation contexts · supported

Automation

When an enabled automation matches its trigger and Where filter, extract event variables and run actions in order. Individual failures are logged and later actions continue. Cooldown is per automation/platform, memory-only. Positive trigger offsets schedule the sequence.

context.automation · 2.8.0

Browse all entries

Requirements and availability

Use the matching SheevChat version.

Picker contexts: automation.

Behavior

When an enabled automation matches its trigger and Where filter, extract event variables and run actions in order. Individual failures are logged and later actions continue. Cooldown is per automation/platform, memory-only. Positive trigger offsets schedule the sequence.

Configure in the app

Open: Bot → Automations → + New

Before opening a new editor, optionally choose + New Category in the relevant Bot tab, enter Category name and click Save. In the editor choose that Category, or leave Uncategorized. Categories organize items; they do not filter stream categories or events.

Initial fields

Name
Choose a descriptive name.
Category
Choose an existing organizational category or Uncategorized.
Enable automation
On by default; switch off while preparing if it must not fire yet.

Steps

  1. Open Bot, then Automations. Create an optional organizational category before choosing + New.
  2. Fill Name, Category and the Enable automation toggle at the top of New Automation.
  3. Open When. Choose Trigger category, then Trigger event. For Platform events choose Platform before Trigger event. Fill Trigger filters and Cooldown (seconds); 0 means no cooldown.
  4. Open Where and select Platform from the supported options for this trigger. Changing the trigger can change the available platform choices.
  5. Open Do (for commands also expand Advanced Actions). Choose an action category and action, then click Add action; alternatively search for its exact label. Expand its card and fill the documented fields using real resource pickers. Repeat for every action. Use Move action up / Move action down to set execution order. Actions run sequentially; adding several does not create parallel execution.
  6. Click Create Automation; use Save Changes when editing. Enable it when ready.
  7. Save, reopen and verify the persisted fields and action order. Test only when the effects are intended: chat, audio, ads and external app actions can affect connected services. A synthetic test does not establish that a real incoming event or platform permission works. Confirm a real eligible event separately during live UAT.

Contract details

Fields
[
  "triggerType",
  "triggerPlatform",
  "triggerFilters",
  "cooldownSec",
  "actions"
]
Defaults
{
  "triggerPlatform": "all",
  "cooldownSec": 0
}
Picker Rule
For command/pad, the action picker exposes all nonhidden actions regardless of declared contexts. Runtime requirements still apply.

Examples

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

{
  "name": "Example welcome",
  "triggerType": "viewer_join",
  "triggerPlatform": "twitch",
  "triggerFilters": {},
  "cooldownSec": 0,
  "actions": [
    {
      "type": "chat",
      "message": "Welcome {user}!",
      "platform": "event"
    }
  ]
}

Source and verification

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

  • src/features/automations.js — fireEvent

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1

Downloads and AI prompt
Download JSONDownload Markdown