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

Timer

Fire independently per selected platform at intervalMin (minimum 1, default 5). Require online status when onlineOnly (default true) and chatLines minimum (default 0). Reset platform line count on eligible firing. Multiple chat actions rotate sequentially/randomly: one selected chat moves to the front, then non-chat actions run. Individual failures log and continue. all/event inner targets are scoped to the eligible platform; explicit different targets are skipped.

context.timer · 2.8.0

Browse all entries

Requirements and availability

Use the matching SheevChat version.

Picker contexts: timer.

Behavior

Fire independently per selected platform at intervalMin (minimum 1, default 5). Require online status when onlineOnly (default true) and chatLines minimum (default 0). Reset platform line count on eligible firing. Multiple chat actions rotate sequentially/randomly: one selected chat moves to the front, then non-chat actions run. Individual failures log and continue. all/event inner targets are scoped to the eligible platform; explicit different targets are skipped.

Configure in the app

Open: Bot → Timers → + 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 timer name.
Category
Existing category or Uncategorized.
Enable timer
On by default.

Steps

  1. Open Bot, then Timers. Create an optional category before clicking + New.
  2. Fill Name, Category and Enable timer.
  3. Open When. Set Interval (minutes), default 5 and minimum 1, and Min chat lines, default 0. With multiple Send Chat Message actions choose Chat message rotation: Sequential or Random.
  4. Open Where. Set Online only (default on) and Active on platforms (Twitch, YouTube and Kick default on; TikTok off). Each selected platform fires independently. TikTok timers only send supported chat messages.
  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 Timer, or Save Changes when editing.
  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
[
  "intervalMin",
  "chatLines",
  "onlineOnly",
  "platforms",
  "rotation",
  "actions"
]
Defaults
{
  "intervalMin": 5,
  "chatLines": 0,
  "onlineOnly": true,
  "rotation": "sequential",
  "platforms": {
    "twitch": true,
    "youtube": true,
    "kick": true,
    "tiktok": false
  }
}
Identity
No incoming viewer. command=timer; timerId/sourceId/sourceName identify the timer.
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 reminder",
  "intervalMin": 5,
  "chatLines": 0,
  "onlineOnly": true,
  "platforms": {
    "twitch": true,
    "youtube": false,
    "kick": false,
    "tiktok": false
  },
  "actions": [
    {
      "type": "chat",
      "message": "Community night is Friday!",
      "platform": "event"
    }
  ]
}

Source and verification

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

  • server.js — _fireTimer / _scopeTimerActionToPlatform

Source revision: 472fb34b484eeef0b663d28cacb628a7b9f14ff1

Downloads and AI prompt
Download JSONDownload Markdown