TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Classes

EventSubAutoModMessageAutoModEventSubAutoModMessageAutoModBoundaryEventSubAutoModMessageBlockedTermEventSubAutoModMessageHoldEventEventSubAutoModMessageHoldV2EventEventSubAutoModMessageUpdateEventEventSubAutoModMessageUpdateV2EventEventSubAutoModSettingsUpdateEventEventSubAutoModTermsUpdateEventEventSubChannelAdBreakBeginEventEventSubChannelAutomaticRewardRedemptionAddEventEventSubChannelAutoModTermsModerationEventEventSubChannelBanEventEventSubChannelBanModerationEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatAnnouncementNotificationEventEventSubChannelChatBitsBadgeTierNotificationEventEventSubChannelChatCharityDonationNotificationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatCommunitySubGiftNotificationEventEventSubChannelChatGiftPaidUpgradeNotificationEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatPayItForwardNotificationEventEventSubChannelChatPrimePaidUpgradeNotificationEventEventSubChannelChatRaidNotificationEventEventSubChannelChatResubNotificationEventEventSubChannelChatSettingsUpdateEventEventSubChannelChatSharedChatAnnouncementNotificationEventEventSubChannelChatSharedChatCommunitySubGiftNotificationEventEventSubChannelChatSharedChatGiftPaidUpgradeNotificationEventEventSubChannelChatSharedChatPayItForwardNotificationEventEventSubChannelChatSharedChatPrimePaidUpgradeNotificationEventEventSubChannelChatSharedChatRaidNotificationEventEventSubChannelChatSharedChatResubNotificationEventEventSubChannelChatSharedChatSubGiftNotificationEventEventSubChannelChatSharedChatSubNotificationEventEventSubChannelChatSubGiftNotificationEventEventSubChannelChatSubNotificationEventEventSubChannelChatUnraidNotificationEventEventSubChannelChatUserMessageHoldEventEventSubChannelChatUserMessageUpdateEventEventSubChannelCheerEventEventSubChannelClearModerationEventEventSubChannelDeleteModerationEventEventSubChannelEmoteOnlyModerationEventEventSubChannelEmoteOnlyOffModerationEventEventSubChannelFollowersModerationEventEventSubChannelFollowersOffModerationEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelModModerationEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRaidModerationEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSharedChatBanModerationEventEventSubChannelSharedChatDeleteModerationEventEventSubChannelSharedChatSessionBeginEventEventSubChannelSharedChatSessionEndEventEventSubChannelSharedChatSessionParticipantEventSubChannelSharedChatSessionUpdateEventEventSubChannelSharedChatTimeoutModerationEventEventSubChannelSharedChatUnbanModerationEventEventSubChannelSharedChatUntimeoutModerationEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSlowModerationEventEventSubChannelSlowOffModerationEventEventSubChannelSubscribersModerationEventEventSubChannelSubscribersOffModerationEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelSuspiciousUserMessageEventEventSubChannelSuspiciousUserUpdateEventEventSubChannelTimeoutModerationEventEventSubChannelUnbanEventEventSubChannelUnbanModerationEventEventSubChannelUnbanRequestCreateEventEventSubChannelUnbanRequestModerationEventEventSubChannelUnbanRequestResolveEventEventSubChannelUniqueChatModerationEventEventSubChannelUniqueChatOffModerationEventEventSubChannelUnmodModerationEventEventSubChannelUnraidModerationEventEventSubChannelUntimeoutModerationEventEventSubChannelUnvipModerationEventEventSubChannelUpdateEventEventSubChannelVipEventEventSubChannelVipModerationEventEventSubChannelWarningAcknowledgeEventEventSubChannelWarningSendEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventEventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubAutomaticRewardTypeEventSubAutoModLevelEventSubAutoModMessageHoldReasonEventSubAutoModResolutionStatusEventSubAutoModTermsUpdateActionEventSubChannelAutomodTermsModerationEventActionEventSubChannelAutomodTermsModerationEventListEventSubChannelBanEvasionEvaluationEventSubChannelChatAnnouncementColorEventSubChannelChatNotificationEventEventSubChannelChatNotificationSubTierEventSubChannelChatNotificationTypeEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelModerationActionEventSubChannelModerationEventEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubChannelSuspiciousUserLowTrustStatusEventSubChannelSuspiciousUserTypeEventSubChannelUnbanRequestStatusEventSubStreamOnlineEventStreamType

EventSubChannelChatSubNotificationEvent

An EventSub event representing a sub notification in a channel's chat.

Overview

Properties

Properties

durationMonths

Type: number

The number of months the subscription is for.

isPrime

Type: boolean

Whether the subscription was "paid" for using Prime Gaming.

tier

Type:
EventSubChannelChatNotificationSubTier

The tier of a subscription. 1000 means tier 1, and so on.

Aliased type: "1000" | "2000" | "3000"

The tier of the subscription.

type

Value: "sub"