`Twitch.AdRun`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.Announcement`

text

null | string

parts

array | null

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

announcementColor

null | string

`Twitch.AutomaticRewardRedemption`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.AutoModMessageHeld`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.AutoModMessageUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BetterTTVEmoteAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BetterTTVEmoteRemoved`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BitsBadgeTier`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

bitBadgeTier

null | string

`Twitch.BlockedTermsAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BlockedTermsDeleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BotEventSubConnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BotEventSubDisconnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BotWhisper`

userrequired

object

whisperId

null | string

whisperText

null | string

isTestrequired

boolean

`Twitch.BroadcasterAuthenticated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BroadcasterChatConnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BroadcasterChatDisconnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BroadcasterEventSubConnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BroadcasterEventSubDisconnected`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.BroadcastUpdate`

channelId

null | string

channel

null | string

status

null | string

oldStatus

null | string

oldGamerequired

object

gamerequired

object

is_testrequired

boolean

`Twitch.CharityCompleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.CharityDonation`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.CharityProgress`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.CharityStarted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatCleared`

moderatorrequired

object

createdAtrequired

string

isTestrequired

boolean

`Twitch.ChatEmoteModeOff`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatEmoteModeOn`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatFollowerModeChanged`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatFollowerModeOff`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatFollowerModeOn`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatMessage`

messagerequired

object

userrequired

object

messageId

null | string

metarequired

object

anonymousrequired

boolean

text

null | string

emotes

array | null

parts

array | null

isReplyrequired

boolean

replyrequired

object

isTestrequired

boolean

sharedChatSourcerequired

object

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

`Twitch.ChatMessageDeleted`

moderatorrequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

messageId

null | string

`Twitch.ChatSlowModeChanged`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatSlowModeOff`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatSlowModeOn`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatSubscriberModeOff`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatSubscriberModeOn`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatUniqueModeOff`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ChatUniqueModeOn`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.Cheer`

messagerequired

object

userrequired

object

messageId

null | string

metarequired

object

anonymousrequired

boolean

text

null | string

emotes

array | null

parts

array | null

isReplyrequired

boolean

replyrequired

object

isTestrequired

boolean

sharedChatSourcerequired

object

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

bitsrequired

integer

cheerEmotes

array | null

`Twitch.CoinCheer`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.CommunityGoalContribution`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.CommunityGoalEnded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.FirstWord`

messagerequired

object

userrequired

object

messageId

null | string

metarequired

object

anonymousrequired

boolean

text

null | string

emotes

array | null

parts

array | null

isReplyrequired

boolean

replyrequired

object

isTestrequired

boolean

sharedChatSourcerequired

object

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

`Twitch.Follow`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GiftBomb`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

null | string

totalrequired

integer

cumulative_total

integer | null

sub_tier

null | string

recipients

array | null

`Twitch.GiftPaidUpgrade`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

gifter_is_anonymousrequired

boolean

gifterUserrequired

object

`Twitch.GiftSub`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

durationMonthsrequired

integer

cumlativeTotalrequired

integer

recipientrequired

object

subTier

null | string

communityGiftId

null | string

fromCommunitySubGiftrequired

boolean

randomCommunitySubGiftrequired

boolean

communitySubGiftCountrequired

integer

communitySubGiftCumulativeTotalrequired

integer

`Twitch.GoalBegin`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GoalEnd`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GoalProgress`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GuestStarGuestUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GuestStarSessionBegin`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GuestStarSessionEnd`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GuestStarSettingsUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.GuestStarSlotUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeChat`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeChatLevel`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeTrainEnd`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeTrainLevelUp`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeTrainStart`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.HypeTrainUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ModeratorAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ModeratorRemoved`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PayItForward`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

gifter_is_anonymousrequired

boolean

gifterUserrequired

object

`Twitch.PermittedTermsAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PermittedTermsDeleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PollArchived`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PollCompleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PollCreated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PollTerminated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PollUpdated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PowerUp`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PredictionCanceled`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PredictionCompleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PredictionCreated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PredictionLocked`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PredictionUpdated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PresentViewers`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.PrimePaidUpgrade`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

upgradeTier

null | string

upgradeTierString

null | string

`Twitch.PyramidBroken`

totalrequired

integer

widthrequired

integer

emote

null | string

userrequired

object

ownerId

null | string

ownerUsername

null | string

ownerDisplay

null | string

`Twitch.PyramidSuccess`

totalrequired

integer

widthrequired

integer

emote

null | string

userrequired

object

`Twitch.Raid`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RaidCancelled`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RaidSend`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RaidStart`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ReSub`

text

null | string

parts

array | null

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

cumulativeMonthsrequired

integer

durationMonthsrequired

integer

streakMonthsrequired

integer

subTier

null | string

isPrimerequired

boolean

isGiftrequired

boolean

gifterIsAnonymous

boolean | null

gifterrequired

object

`Twitch.RewardCreated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RewardDeleted`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RewardRedemption`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RewardRedemptionUpdated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.RewardUpdated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.SevenTVEmoteAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.SevenTVEmoteRemoved`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.SharedChatAnnouncement`

text

null | string

parts

array | null

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

announcementColor

null | string

`Twitch.SharedChatCommunitySubGift`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

null | string

totalrequired

integer

cumulative_total

integer | null

sub_tier

null | string

recipients

array | null

`Twitch.SharedChatGiftPaidUpgrade`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

gifter_is_anonymousrequired

boolean

gifterUserrequired

object

`Twitch.SharedChatMessageDeleted`

moderatorrequired

object

sourcerequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

messageId

null | string

`Twitch.SharedChatPayItForward`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

gifter_is_anonymousrequired

boolean

gifterUserrequired

object

`Twitch.SharedChatPrimePaidUpgrade`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

upgradeTier

null | string

upgradeTierString

null | string

`Twitch.SharedChatRaid`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

viewerCountrequired

integer

`Twitch.SharedChatResub`

text

null | string

parts

array | null

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

cumulativeMonthsrequired

integer

durationMonthsrequired

integer

streakMonthsrequired

integer

subTier

null | string

isPrimerequired

boolean

isGiftrequired

boolean

gifterIsAnonymous

boolean | null

gifterrequired

object

`Twitch.SharedChatSessionBegin`

hostrequired

object

sessionId

null | string

isTestrequired

boolean

participants

array | null

`Twitch.SharedChatSessionEnd`

hostrequired

object

sessionId

null | string

isTestrequired

boolean

`Twitch.SharedChatSessionUpdate`

hostrequired

object

sessionId

null | string

isTestrequired

boolean

participants

array | null

`Twitch.SharedChatSub`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

sub_tier

null | string

is_primerequired

boolean

duration_monthsrequired

integer

`Twitch.SharedChatSubGift`

userrequired

object

sourcerequired

object

sourceMessageId

null | string

sourceBadges

array | null

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

durationMonthsrequired

integer

cumlativeTotalrequired

integer

recipientrequired

object

subTier

null | string

communityGiftId

null | string

fromCommunitySubGiftrequired

boolean

randomCommunitySubGiftrequired

boolean

communitySubGiftCountrequired

integer

communitySubGiftCumulativeTotalrequired

integer

`Twitch.SharedChatUserBanned`

moderatorrequired

object

sourcerequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

reason

null | string

`Twitch.SharedChatUserTimedout`

moderatorrequired

object

sourcerequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

reason

null | string

durationrequired

integer

`Twitch.SharedChatUserUnbanned`

moderatorrequired

object

sourcerequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

`Twitch.SharedChatUserUntimedout`

moderatorrequired

object

sourcerequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

`Twitch.ShieldModeBegin`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ShieldModeEnd`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ShoutoutCreated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.ShoutoutReceived`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.StreamOffline`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.StreamOnline`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.StreamUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.StreamUpdateGameOnConnect`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.Sub`

userrequired

object

messageId

null | string

systemMessage

null | string

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

sub_tier

null | string

is_primerequired

boolean

duration_monthsrequired

integer

`Twitch.SubCounterRollover`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.SuspiciousUserMessage`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.SuspiciousUserUpdate`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.UnbanRequestApproved`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.UnbanRequestCreated`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.UnbanRequestDenied`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.UpcomingAd`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.UserBanned`

moderatorrequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

reason

null | string

`Twitch.UserTimedOut`

moderatorrequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

reason

null | string

durationrequired

integer

`Twitch.UserUnbanned`

moderatorrequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

`Twitch.UserUntimedOut`

moderatorrequired

object

isTestrequired

boolean

isInSharedChatrequired

boolean

isSharedChatHostrequired

boolean

isFromSharedChatGuestrequired

boolean

targetUserrequired

object

`Twitch.ViewerCountUpdate`

broadcasterrequired

object

viewerCountrequired

integer

isTestrequired

boolean

`Twitch.VipAdded`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.VipRemoved`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.WarnedUser`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.WarningAcknowledged`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.WatchStreak`

Missing Documentation

No schema defined for this event. Check back soon!

`Twitch.Whisper`

userrequired

object

whisperId

null | string

whisperText

null | string

isTestrequired

boolean

Twitch Events