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.
All Topics
| 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.tips | tips:read | Tip/donation events |
| channel.tips.moderation | tips:moderation | Tip moderation events |
| channel.chat.message | overlays:read | Individual chat messages |
| channel.session.update | session:read | Individual session data updates |
| channel.session.reset | session:read | Full session reset events |
| 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 |
channel.chatbot.commands | bot:read | Chatbot command updates |
channel.chatbot.timers | bot:read | Chatbot timer updates |
| channel.chatbot.counters | (none) | Chatbot counter value changes |
channel.chatbot.filters | bot:read | Chatbot filter updates |
| channel.stream.status | stream-live:read | Stream online/offline status changes |
| 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 |
| channel.songrequest | overlays:read | Song request events |
| channel.contests | (none) | Contest and prediction events |
| channel.giveaways | (none) | Giveaway events |
channel.loyalty.redemptions | store:read | Loyalty store redemption events |
channel.loyalty.items | store:read | Loyalty store item updates |