Automation
Configure the automation engine and template variables.
Overview
The automation engine allows you to create rules that trigger actions based on streaming events. Rules are evaluated in real-time and can execute chat commands, overlay updates, or API calls.
Permissions
Automations use six dedicated permissions:
| Permission | Description |
|---|---|
automations:read | View automations and their configuration |
automations:create | Create new automations |
automations:edit | Edit automation metadata, nodes, edges |
automations:delete | Delete automations |
automations:execute | Manually trigger and start/stop automations |
automations:history | View execution history and debug logs |
Template Variables
The template engine supports 60+ variables across multiple categories. Variables are wrapped in {{doubleCurlyBraces}} and resolved at execution time.
For the full variable reference, see:
- User guide: Automation Templates
- Developer guide: Automation Template Engine
Quick Reference
| Category | Example | Permission |
|---|---|---|
| Channel | {{channelName}}, {{platform}} | None |
| Bot | {{botName}}, {{commandPrefix}} | None |
| Time | {{date}}, {{time}}, {{timezone}} | None |
| User | {{username}}, {{displayName}} | chat:userinfo |
| Stream | {{streamTitle}}, {{category}}, {{viewerCount}} | events:read |
| Events | {{followerName}}, {{cheerAmount}}, {{subTier}} | events:read |
| Spotify | {{songName}}, {{songArtist}}, {{isPlaying}} | spotify:read |
Rule Configuration
Rules consist of:
- Trigger -- The event type that activates the rule
- Conditions -- Optional filters (minimum amount, specific platform, etc.)
- Actions -- What to do when triggered (send message, update overlay, etc.)
REST API
All automation endpoints are under /v1/automations. See the REST API reference for full details.
| Method | Path | Permission |
|---|---|---|
GET | /v1/automations | automations:read |
POST | /v1/automations | automations:create |
GET | /v1/automations/{id} | automations:read |
PATCH | /v1/automations/{id} | automations:edit |
DELETE | /v1/automations/{id} | automations:delete |
PUT | /v1/automations/{id}/nodes | automations:edit |
PUT | /v1/automations/{id}/edges | automations:edit |