Twurple Authentication Getting data Examples FAQ Migration

Reference

api api-call auth auth-tmi chat common easy-bot ebs-helper eventsub-base eventsub-http eventsub-ws pubsub

Classes

EventSubAutoModMessageAutoMod EventSubAutoModMessageAutoModBoundary EventSubAutoModMessageBlockedTerm EventSubAutoModMessageHoldEvent EventSubAutoModMessageHoldV2Event EventSubAutoModMessageUpdateEvent EventSubAutoModMessageUpdateV2Event EventSubAutoModSettingsUpdateEvent EventSubAutoModTermsUpdateEvent EventSubChannelAdBreakBeginEvent EventSubChannelAutomaticReward EventSubChannelAutomaticRewardRedemptionAddEvent EventSubChannelAutomaticRewardRedemptionAddV2Event EventSubChannelAutoModTermsModerationEvent EventSubChannelBanEvent EventSubChannelBanModerationEvent EventSubChannelBitsUseEvent EventSubChannelBitsUsePowerUp EventSubChannelCharityAmount EventSubChannelCharityCampaignProgressEvent EventSubChannelCharityCampaignStartEvent EventSubChannelCharityCampaignStopEvent EventSubChannelCharityDonationEvent EventSubChannelChatAnnouncementNotificationEvent EventSubChannelChatBitsBadgeTierNotificationEvent EventSubChannelChatCharityDonationNotificationEvent EventSubChannelChatClearEvent EventSubChannelChatClearUserMessagesEvent EventSubChannelChatCommunitySubGiftNotificationEvent EventSubChannelChatGiftPaidUpgradeNotificationEvent EventSubChannelChatMessageDeleteEvent EventSubChannelChatMessageEvent EventSubChannelChatPayItForwardNotificationEvent EventSubChannelChatPrimePaidUpgradeNotificationEvent EventSubChannelChatRaidNotificationEvent EventSubChannelChatResubNotificationEvent EventSubChannelChatSettingsUpdateEvent EventSubChannelChatSharedChatAnnouncementNotificationEvent EventSubChannelChatSharedChatCommunitySubGiftNotificationEvent EventSubChannelChatSharedChatGiftPaidUpgradeNotificationEvent EventSubChannelChatSharedChatPayItForwardNotificationEvent EventSubChannelChatSharedChatPrimePaidUpgradeNotificationEvent EventSubChannelChatSharedChatRaidNotificationEvent EventSubChannelChatSharedChatResubNotificationEvent EventSubChannelChatSharedChatSubGiftNotificationEvent EventSubChannelChatSharedChatSubNotificationEvent EventSubChannelChatSubGiftNotificationEvent EventSubChannelChatSubNotificationEvent EventSubChannelChatUnraidNotificationEvent EventSubChannelChatUserMessageHoldEvent EventSubChannelChatUserMessageUpdateEvent EventSubChannelCheerEvent EventSubChannelClearModerationEvent EventSubChannelDeleteModerationEvent EventSubChannelEmoteOnlyModerationEvent EventSubChannelEmoteOnlyOffModerationEvent EventSubChannelFollowersModerationEvent EventSubChannelFollowersOffModerationEvent EventSubChannelFollowEvent EventSubChannelGoalBeginEvent EventSubChannelGoalEndEvent EventSubChannelGoalProgressEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainBeginV2Event EventSubChannelHypeTrainContribution EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainEndV2Event EventSubChannelHypeTrainProgressEvent EventSubChannelHypeTrainProgressV2Event EventSubChannelHypeTrainSharedParticipant EventSubChannelModeratorEvent EventSubChannelModModerationEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRaidModerationEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelSharedChatBanModerationEvent EventSubChannelSharedChatDeleteModerationEvent EventSubChannelSharedChatSessionBeginEvent EventSubChannelSharedChatSessionEndEvent EventSubChannelSharedChatSessionParticipant EventSubChannelSharedChatSessionUpdateEvent EventSubChannelSharedChatTimeoutModerationEvent EventSubChannelSharedChatUnbanModerationEvent EventSubChannelSharedChatUntimeoutModerationEvent EventSubChannelShieldModeBeginEvent EventSubChannelShieldModeEndEvent EventSubChannelShoutoutCreateEvent EventSubChannelShoutoutReceiveEvent EventSubChannelSlowModerationEvent EventSubChannelSlowOffModerationEvent EventSubChannelSubscribersModerationEvent EventSubChannelSubscribersOffModerationEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelSuspiciousUserMessageEvent EventSubChannelSuspiciousUserUpdateEvent EventSubChannelTimeoutModerationEvent EventSubChannelUnbanEvent EventSubChannelUnbanModerationEvent EventSubChannelUnbanRequestCreateEvent EventSubChannelUnbanRequestModerationEvent EventSubChannelUnbanRequestResolveEvent EventSubChannelUniqueChatModerationEvent EventSubChannelUniqueChatOffModerationEvent EventSubChannelUnmodModerationEvent EventSubChannelUnraidModerationEvent EventSubChannelUntimeoutModerationEvent EventSubChannelUnvipModerationEvent EventSubChannelUpdateEvent EventSubChannelVipEvent EventSubChannelVipModerationEvent EventSubChannelWarningAcknowledgeEvent EventSubChannelWarningSendEvent EventSubChannelWarnModerationEvent EventSubDropEntitlementGrantEvent EventSubExtensionBitsTransactionCreateEvent EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationGrantEvent EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent EventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfig EventSubListener

Type aliases

EventSubAutomaticRewardType EventSubAutoModLevel EventSubAutoModMessageHoldReason EventSubAutoModResolutionStatus EventSubAutoModTermsUpdateAction EventSubChannelAutomaticRewardType EventSubChannelAutomodTermsModerationEventAction EventSubChannelAutomodTermsModerationEventList EventSubChannelBanEvasionEvaluation EventSubChannelBitsUsePowerUpType EventSubChannelBitsUseType EventSubChannelChatAnnouncementColor EventSubChannelChatNotificationEvent EventSubChannelChatNotificationSubTier EventSubChannelChatNotificationType EventSubChannelGoalType EventSubChannelHypeTrainContributionType EventSubChannelHypeTrainType EventSubChannelModerationAction EventSubChannelModerationEvent EventSubChannelPollEndStatus EventSubChannelPredictionColor EventSubChannelPredictionEndStatus EventSubChannelSubscriptionEndEventTier EventSubChannelSubscriptionEventTier EventSubChannelSubscriptionGiftEventTier EventSubChannelSubscriptionMessageEventTier EventSubChannelSuspiciousUserLowTrustStatus EventSubChannelSuspiciousUserType EventSubChannelUnbanRequestStatus EventSubStreamOnlineEventStreamType

EventSubChannelHypeTrainBeginV2Event

An EventSub event representing a Hype Train starting in a channel.

Overview

Properties

Methods

getBroadcastera

Properties

allTimeHighLevel

Type: number

The all-time high level this type of Hype Train has reached for this broadcaster.

allTimeHighTotal

Type: number

The all-time high total this type of Hype Train has reached for this broadcaster.

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

expiryDate

Type: Date

The time when the Hype Train is expected to expire, unless a change of level occurs to extend the expiration.

goal

Type: number

The number of points required to reach the next level.

id

Type: string

The ID of the Hype Train.

isSharedTrain

Type: boolean

Indicates if the Hype Train is shared.

When true, EventSubChannelHypeTrainBeginV2Event#sharedTrainParticipants will contain the list of broadcasters the train is shared with.

level

Type: number

The level the Hype Train started on.

progress

Type: number

The number of points contributed to the Hype Train at the current level.

sharedTrainParticipants

Type: EventSubChannelHypeTrainSharedParticipant[]

The list of broadcasters in the shared Hype Train.

Empty if EventSubChannelHypeTrainBeginV2Event#isSharedTrain is false.

startDate

Type: Date

The time when the Hype Train started.

topContributors

Type: EventSubChannelHypeTrainContribution[]

The contributors with the most points contributed.

total

Type: number

The total points already contributed to the Hype Train.

type

Type: EventSubChannelHypeTrainType

The type of the Hype Train.

Methods

getBroadcaster()

Gets more information about the broadcaster.

Return type: HelixUser