Api
Events
All events that can be subscribed to from the Streamer.bot WebSocket Server
Responses
Explore documented event responses on the Steamer.bot Docs
Subscription Type
Events are organized by the top-level Event Source key containing an array of Event Types
When using the
.on() method, you can utilize the shorthand [source].[type] syntax:
client.on('Application.ActionAdded', (data) => { console.log(data) })StreamerbotEventsSubscription.ts
const StreamerbotEvents = {
Application: ['ActionAdded', 'ActionUpdated', 'ActionDeleted'],
Command: ['Triggered', 'Cooldown'],
CrowdControl: [
'GameSessionStart',
'GameSessionEnd',
'EffectRequest',
'EffectSuccess',
'EffectFailure',
'TimedEffectStarted',
'TimedEffectEnded',
'TimedEffectUpdated',
],
Custom: ['Event', 'CodeEvent'],
DonorDrive: ['Donation', 'ProfileUpdated', 'Incentive'],
Elgato: [
'WaveLinkOutputSwitched',
'WaveLinkOutputVolumeChanged',
'WaveLinkOutputMuteChanged',
'WaveLinkSelectedOutputChanged',
'WaveLinkInputVolumeChanged',
'WaveLinkInputMuteChanged',
'WaveLinkInputNameChanged',
'WaveLinkMicrophoneGainChanged',
'WaveLinkMicrophoneOutputVolumeChanged',
'WaveLinkMicrophoneBalanceChanged',
'WaveLinkMicrophoneMuteChanged',
'WaveLinkMicrophoneSettingChanged',
'WaveLinkFilterAdded',
'WaveLinkFilterChanged',
'WaveLinkFilterDeleted',
'WaveLinkFilterBypassStateChanged',
'WaveLinkConnected',
'WaveLinkDisconnected',
'WaveLinkInputLevelMeterChanged',
'WaveLinkOutputLevelMeterChanged',
],
FileTail: ['Changed'],
FileWatcher: ['Changed', 'Created', 'Deleted', 'Renamed'],
Fourthwall: [
'ProductCreated',
'ProductUpdated',
'GiftPurchase',
'OrderPlaced',
'OrderUpdated',
'Donation',
'SubscriptionPurchased',
'SubscriptionExpired',
'SubscriptionChanged',
],
General: ['Custom'],
HotKey: ['Press'],
HypeRate: ['HeartRatePulse'],
Kofi: ['Donation', 'Subscription', 'Resubscription', 'ShopOrder', 'Commission'],
Midi: ['Message'],
Misc: [
'TimedAction',
'Test',
'ProcessStarted',
'ProcessStopped',
'ChatWindowAction',
'StreamerbotStarted',
'StreamerbotExiting',
'ToastActivation',
'GlobalVariableUpdated',
'ApplicationImport',
],
Obs: [
'Connected',
'Disconnected',
'Event',
'SceneChanged',
'StreamingStarted',
'StreamingStopped',
'RecordingStarted',
'RecordingStopped',
],
Patreon: ['FollowCreated', 'FollowDeleted', 'PledgeCreated', 'PledgeUpdated', 'PledgeDeleted'],
Pulsoid: ['HeartRatePulse'],
Quote: ['Added', 'Show'],
Raw: ['Action', 'SubAction', 'ActionCompleted'],
Shopify: ['OrderCreated', 'OrderPaid'],
SpeakerBot: ['Connected', 'Disconnected'],
SpeechToText: ['Dictation', 'Command'],
StreamDeck: ['Action', 'Connected', 'Disconnected', 'Info'],
StreamElements: ['Tip', 'Merch', 'Connected', 'Disconnected'],
Streamlabs: ['Donation', 'Merchandise', 'Connected', 'Disconnected'],
StreamlabsDesktop: [
'Connected',
'Disconnected',
'SceneChanged',
'StreamingStarted',
'StreamingStopped',
'RecordingStarted',
'RecordingStopped',
],
ThrowingSystem: [
'Connected',
'WebsocketConnected',
'WebsocketDisconnected',
'EventsConnected',
'EventsDisconnected',
'ItemHit',
'TriggerActivated',
'TriggerEnded',
],
TipeeeStream: ['Donation'],
TreatStream: ['Treat'],
Trovo: [
'BroadcasterAuthenticated',
'BroadcasterChatConnected',
'BroadcasterChatDisconnected',
'FirstWords',
'PresentViewers',
'ChatMessage',
'Follow',
'SpellCast',
'CustomSpellCast',
'Raid',
'Subscription',
'Resubscription',
'GiftSubscription',
'MassGiftSubscription',
'StreamOnline',
'StreamOffline',
],
Twitch: [
'Follow',
'Cheer',
'Sub',
'ReSub',
'GiftSub',
'GiftBomb',
'Raid',
'HypeTrainStart',
'HypeTrainUpdate',
'HypeTrainLevelUp',
'HypeTrainEnd',
'RewardRedemption',
'RewardCreated',
'RewardUpdated',
'RewardDeleted',
'CommunityGoalContribution',
'CommunityGoalEnded',
'StreamUpdate',
'Whisper',
'FirstWord',
'SubCounterRollover',
'BroadcastUpdate',
'StreamUpdateGameOnConnect',
'PresentViewers',
'PollCreated',
'PollUpdated',
'PollCompleted',
'PredictionCreated',
'PredictionUpdated',
'PredictionCompleted',
'PredictionCanceled',
'PredictionLocked',
'ChatMessage',
'ChatMessageDeleted',
'UserTimedOut',
'UserBanned',
'Announcement',
'AdRun',
'BotWhisper',
'CharityDonation',
'CharityCompleted',
'CoinCheer',
'ShoutoutCreated',
'UserUntimedOut',
'CharityStarted',
'CharityProgress',
'GoalBegin',
'GoalProgress',
'GoalEnd',
'ShieldModeBegin',
'ShieldModeEnd',
'AdMidRoll',
'StreamOnline',
'StreamOffline',
'ShoutoutReceived',
'ChatCleared',
'RaidStart',
'RaidSend',
'RaidCancelled',
'PollTerminated',
'PyramidSuccess',
'PyramidBroken',
'ViewerCountUpdate',
'GuestStarSessionBegin',
'GuestStarSessionEnd',
'GuestStarGuestUpdate',
'GuestStarSlotUpdate',
'GuestStarSettingsUpdate',
'HypeChat',
'RewardRedemptionUpdated',
'HypeChatLevel',
'BroadcasterAuthenticated',
'BroadcasterChatConnected',
'BroadcasterChatDisconnected',
'BroadcasterPubSubConnected',
'BroadcasterPubSubDisconnected',
'BroadcasterEventSubConnected',
'BroadcasterEventSubDisconnected',
'SevenTVEmoteAdded',
'SevenTVEmoteRemoved',
'BetterTTVEmoteAdded',
'BetterTTVEmoteRemoved',
'BotChatConnected',
'BotChatDisconnected',
'UpcomingAd',
],
VStream: [
'BroadcasterAuthenticated',
'BroadcasterChatConnected',
'BroadcasterChatDisconnected',
'FirstWords',
'PresentViewers',
'ChatMessage',
'NewFollower',
'StreamOnline',
'StreamOffline',
],
VTubeStudio: [
'ModelLoaded',
'ModelUnloaded',
'BackgroundChanged',
'ModelConfigChanged',
'HotkeyTriggered',
'ModelAnimation',
'Connected',
'Disconnected',
'TrackingStatusChanged',
],
WebsocketClient: ['Open', 'Close', 'Message'],
WebsocketCustomServer: ['Open', 'Close', 'Message'],
YouTube: [
'BroadcastStarted',
'BroadcastEnded',
'Message',
'MessageDeleted',
'UserBanned',
'SuperChat',
'SuperSticker',
'NewSponsor',
'MemberMileStone',
'NewSponsorOnlyStarted',
'NewSponsorOnlyEnded',
'StatisticsUpdated',
'BroadcastUpdated',
'MembershipGift',
'GiftMembershipReceived',
'FirstWords',
'PresentViewers',
'NewSubscriber',
],
};