TwurpleAuthenticationGetting dataExamplesFAQMigration

Classes

EventSubAutoModMessageAutoModEventSubAutoModMessageAutoModBoundaryEventSubAutoModMessageBlockedTermEventSubAutoModMessageHoldEventEventSubAutoModMessageHoldV2EventEventSubAutoModMessageUpdateEventEventSubAutoModMessageUpdateV2EventEventSubAutoModSettingsUpdateEventEventSubAutoModTermsUpdateEventEventSubChannelAdBreakBeginEventEventSubChannelAutomaticRewardEventSubChannelAutomaticRewardRedemptionAddEventEventSubChannelAutomaticRewardRedemptionAddV2EventEventSubChannelAutoModTermsModerationEventEventSubChannelBanEventEventSubChannelBanModerationEventEventSubChannelBitsUseEventEventSubChannelBitsUsePowerUpEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatAnnouncementNotificationEventEventSubChannelChatBitsBadgeTierNotificationEventEventSubChannelChatCharityDonationNotificationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatCommunitySubGiftNotificationEventEventSubChannelChatGiftPaidUpgradeNotificationEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatPayItForwardNotificationEventEventSubChannelChatPrimePaidUpgradeNotificationEventEventSubChannelChatRaidNotificationEventEventSubChannelChatResubNotificationEventEventSubChannelChatSettingsUpdateEventEventSubChannelChatSharedChatAnnouncementNotificationEventEventSubChannelChatSharedChatCommunitySubGiftNotificationEventEventSubChannelChatSharedChatGiftPaidUpgradeNotificationEventEventSubChannelChatSharedChatPayItForwardNotificationEventEventSubChannelChatSharedChatPrimePaidUpgradeNotificationEventEventSubChannelChatSharedChatRaidNotificationEventEventSubChannelChatSharedChatResubNotificationEventEventSubChannelChatSharedChatSubGiftNotificationEventEventSubChannelChatSharedChatSubNotificationEventEventSubChannelChatSubGiftNotificationEventEventSubChannelChatSubNotificationEventEventSubChannelChatUnraidNotificationEventEventSubChannelChatUserMessageHoldEventEventSubChannelChatUserMessageUpdateEventEventSubChannelCheerEventEventSubChannelClearModerationEventEventSubChannelDeleteModerationEventEventSubChannelEmoteOnlyModerationEventEventSubChannelEmoteOnlyOffModerationEventEventSubChannelFollowersModerationEventEventSubChannelFollowersOffModerationEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainBeginV2EventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainEndV2EventEventSubChannelHypeTrainProgressEventEventSubChannelHypeTrainProgressV2EventEventSubChannelHypeTrainSharedParticipantEventSubChannelModeratorEventEventSubChannelModModerationEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRaidModerationEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSharedChatBanModerationEventEventSubChannelSharedChatDeleteModerationEventEventSubChannelSharedChatSessionBeginEventEventSubChannelSharedChatSessionEndEventEventSubChannelSharedChatSessionParticipantEventSubChannelSharedChatSessionUpdateEventEventSubChannelSharedChatTimeoutModerationEventEventSubChannelSharedChatUnbanModerationEventEventSubChannelSharedChatUntimeoutModerationEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSlowModerationEventEventSubChannelSlowOffModerationEventEventSubChannelSubscribersModerationEventEventSubChannelSubscribersOffModerationEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelSuspiciousUserMessageEventEventSubChannelSuspiciousUserUpdateEventEventSubChannelTimeoutModerationEventEventSubChannelUnbanEventEventSubChannelUnbanModerationEventEventSubChannelUnbanRequestCreateEventEventSubChannelUnbanRequestModerationEventEventSubChannelUnbanRequestResolveEventEventSubChannelUniqueChatModerationEventEventSubChannelUniqueChatOffModerationEventEventSubChannelUnmodModerationEventEventSubChannelUnraidModerationEventEventSubChannelUntimeoutModerationEventEventSubChannelUnvipModerationEventEventSubChannelUpdateEventEventSubChannelVipEventEventSubChannelVipModerationEventEventSubChannelWarningAcknowledgeEventEventSubChannelWarningSendEventEventSubChannelWarnModerationEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventEventSubUserWhisperMessageEvent

EventSubChannelBitsUseEvent

An EventSub event representing bits being used in a channel.

Overview

Properties

bits

Type: number

The number of bits used.

broadcasterDisplayName

Type: string

The display name of the broadcaster in whose channel the bits were used.

broadcasterId

Type: string

The ID of the broadcaster in whose channel the bits were used.

broadcasterName

Type: string

The name of the broadcaster in whose channel the bits were used.

messageParts

Type: EventSubChannelBitsUseMessagePart[] | null

Ordered list of chat message fragments, or null if it's not applicable.

messageText

Type: string | null

The chat message in plain text, or null if it's not applicable.

powerUp

Type: EventSubChannelBitsUsePowerUp | null

The Power-up data, or null if it's not applicable.

type

Type: EventSubChannelBitsUseType

The type of the bits usage.

userDisplayName

Type: string

The display name of the user who has used bits.

userId

Type: string

The ID of the user who has used bits.

userName

Type: string

The name of the user who has used bits.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getUser()

async

Gets more information about the user.

Return type: HelixUser