Skip to main content

Events

twitch-load#

Fires when twitch plugin is loaded

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

twitch-unload#

Fires when twitch plugin is unloaded

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

twitch-open#

Fires when twitch is connected

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

twitch-close#

Fires when twitch is disconnected

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

twitch-error#

Fires when twitch have a connection error

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.errorErrorError throw

twitch-follow // TODO#

Fires when a user follow your channel.

twitch-message#

Fires when a user sends a message to your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.messagestringData of the event
payload.msgTwitchPrivateMessageData of the event

twitch-action#

Fires when a user sends an action (/me) to your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.messagestringData of the event
payload.msgTwitchPrivateMessageData of the event

twitch-ban#

Fires when a user is permanently banned from your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event

twitch-bits-badge-upgrade#

Fires when a user upgrades their bits badge in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatBitsBadgeUpgradeInfoData of the event
payload.msgUserNoticeData of the event

twitch-chat-clear#

Fires when the chat of your channel is cleared.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadnullData of the event

twitch-community-pay-forward#

Fires when a user pays forward a subscription that was gifted to them to the community.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatCommunityPayForwardInfoData of the event
payload.msgUserNoticeData of the event

twitch-community-sub#

Fires when a user gifts random subscriptions to the community of your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatCommunitySubInfoData of the event
payload.msgUserNoticeData of the event

twitch-emote-only#

Fires when emote-only mode is toggled in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.enabledbooleanData of the event

twitch-follower-only#

Fires when followers-only mode is toggled in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.enabledbooleanData of the event
payload.delaynumberData of the event

twitch-gift-paid-upgrade#

Fires when a user upgrades their gift subscription to a paid subscription in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubGiftUpgradeInfoData of the event
payload.msgUserNoticeData of the event

twitch-host#

Fires when your channel hosts another channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.targetstringData of the event
payload.viewersnumberData of the event

twitch-hosted#

Fires when your channel you're logged in is being hosted by another channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.channelstringData of the event
payload.autobooleanData of the event
payload.viewersnumberData of the event

twitch-hosts-remaining#

Fires when Twitch tells you the number of hosts you have remaining in the next half hour for the channel for which you're logged in as owner after hosting a channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.numberOfHostsnumberData of the event

twitch-join#

Fires when a user joins a channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event

twitch-part#

Fires when a user sends a message to a channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event

twitch-prime-community-gift#

Fires when a user gifts a Twitch Prime benefit to the channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatPrimeCommunityGiftInfoData of the event
payload.msgUserNoticeData of the event

twitch-prime-paid-upgrade#

Fires when a user upgrades their Prime subscription to a paid subscription in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubUpgradeInfoData of the event
payload.msgUserNoticeData of the event

twitch-r9k#

Fires when a user upgrades their Prime subscription to a paid subscription in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.enabledbooleanData of the event

twitch-raid#

Fires when a user raids your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatRaidInfoData of the event
payload.msgUserNoticeData of the event

twitch-raid-cancel#

Fires when you cancels a raid.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.msgUserNoticeData of the event

twitch-resub#

Fires when a user resubscribes to your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubInfoData of the event
payload.msgUserNoticeData of the event

twitch-reward-gift#

Fires when a user gifts rewards during a special event.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatRewardGiftInfoData of the event
payload.msgUserNoticeData of the event

twitch-ritual#

Fires when a user performs a "ritual" in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatRitualInfoData of the event
payload.msgUserNoticeData of the event

twitch-slow#

Fires when slow mode is toggled in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.enabledbooleanData of the event
payload.delaynumberData of the event

twitch-standard-pay-forward#

Fires when a user pays forward a subscription that was gifted to them to a specific user.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatStandardPayForwardInfoData of the event
payload.msgUserNoticeData of the event

twitch-sub#

Fires when a user subscribes to your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubInfoData of the event
payload.msgUserNoticeData of the event

twitch-sub-extend#

Fires when a user extends their subscription using a Sub Token.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubExtendInfoData of the event
payload.msgUserNoticeData of the event

twitch-sub-gift#

Fires when a user gifts a subscription to your channel to another user.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.infoChatSubGiftInfoData of the event
payload.msgUserNoticeData of the event

twitch-subs-only#

Fires when sub only mode is toggled in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.enabledbooleanData of the event

twitch-timeout#

Fires when a user is timed out from your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.durationnumberData of the event

twitch-unhost#

Fires when host mode is disabled in your channel.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.channelstringData of the event

twitch-whisper#

Fires when receiving a whisper from another user.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringData of the event
payload.messagestringData of the event
payload.msgobjectData of the event

twitch-channel-point-redeem#

Fires when a user redeems channel points.

FieldTypeDescription
idstringUnique Event ID
eventstringEvent type
emittedAtDateDate on which the event was emitted
emitterstringOrigin of the event
payloadobjectData of the event
payload.userstringuser who claim point
payload.titlestringRedemption title
payload.messagestringRedemption message
payload.msgPubSubRedemptionMessageData of the event