Topics
This section provides documentation for the various topics available for subscription through the Astro Websocket Gateway.
Topics follow a dot-separated naming convention. Topics with no required scope are accessible to any authenticated token. The owner scope * grants access to all topics.
Session & Stream
Section titled “Session & Stream”| Topic | Required Scope | Description |
|---|---|---|
| channel.session.update | session:read |
Individual session data updates |
| channel.session.reset | session:read |
Full session reset events |
| channel.stream.status | stream-live:read |
Stream online/offline status changes |
Activity & Engagement
Section titled “Activity & Engagement”| Topic | Required Scope | Description |
|---|---|---|
| channel.activities | activities:read |
Channel activities like follows, subscriptions, and donations |
channel.announcements |
channel:read |
Channel announcement events |
channel.chatstats |
(none) | Chat statistics updates |
| channel.chat.message | overlays:read |
Individual chat messages |
| channel.tips | tips:read |
Tip/donation events |
| channel.tips.moderation | tips:moderation |
Tip moderation events |
| channel.contests | (none) | Contest and prediction events |
| channel.giveaways | (none) | Giveaway events |
| channel.songrequest | overlays:read |
Song request events |
channel.loyalty.redemptions |
store:read |
Loyalty store redemption events |
channel.loyalty.items |
store:read |
Loyalty store item updates |
Overlays
Section titled “Overlays”| Topic | Required Scope | Description |
|---|---|---|
| channel.overlay.action | overlays:read |
Overlay action events (pause, mute, skip, etc.) |
| channel.overlay.broadcast | overlays:broadcast |
Custom broadcast events targeting overlays |
| channel.overlay.update | overlays:read |
Overlay update notifications |
channel.kvstore.update |
kvstore:read |
Key-value store update events |
Chatbot
Section titled “Chatbot”| Topic | Required Scope | Description |
|---|---|---|
| channel.chatbot.status | bot:read |
Chatbot connection status changes |
| channel.chatbot.modules.pyramid | bot:read |
Chat pyramid detection events |
| channel.chatbot.modules.emotecombo | bot:read |
Emote combo trigger events |
channel.chatbot.modules |
bot:read |
General chatbot module updates Not published |
channel.chatbot.commands |
bot:read |
Chatbot command updates Not published |
channel.chatbot.timers |
bot:read |
Chatbot timer updates Not published |
| channel.chatbot.counters | (none) | Chatbot counter value changes |
channel.chatbot.filters |
bot:read |
Chatbot filter updates Not published |
| channel.chatbot.timeout | — | User timeout notifications In development |