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

EventSubChannelAdBreakBeginEvent EventSubChannelBanEvent EventSubChannelCharityAmount EventSubChannelCharityCampaignProgressEvent EventSubChannelCharityCampaignStartEvent EventSubChannelCharityCampaignStopEvent EventSubChannelCharityDonationEvent EventSubChannelChatClearEvent EventSubChannelChatClearUserMessagesEvent EventSubChannelChatMessageDeleteEvent EventSubChannelChatMessageEvent EventSubChannelChatSettingsUpdateEvent EventSubChannelCheerEvent EventSubChannelFollowEvent EventSubChannelGoalBeginEvent EventSubChannelGoalEndEvent EventSubChannelGoalProgressEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainContribution EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainProgressEvent EventSubChannelModeratorEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelShieldModeBeginEvent EventSubChannelShieldModeEndEvent EventSubChannelShoutoutCreateEvent EventSubChannelShoutoutReceiveEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelUnbanEvent EventSubChannelUpdateEvent EventSubDropEntitlementGrantEvent EventSubExtensionBitsTransactionCreateEvent EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationGrantEvent EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent

Interfaces

EventSubBaseConfig EventSubListener

Type aliases

EventSubChannelChatNotificationEvent EventSubChannelGoalType EventSubChannelHypeTrainContributionType EventSubChannelPollEndStatus EventSubChannelPredictionColor EventSubChannelPredictionEndStatus EventSubChannelSubscriptionEndEventTier EventSubChannelSubscriptionEventTier EventSubChannelSubscriptionGiftEventTier EventSubChannelSubscriptionMessageEventTier EventSubStreamOnlineEventStreamType

EventSubChannelRaidEvent

An EventSub event representing a broadcaster raiding another broadcaster.

Overview

Properties

Methods

Properties

raidedBroadcasterDisplayName

Type: string

The display name of the raided broadcaster.

raidedBroadcasterId

Type: string

The ID of the raided broadcaster.

raidedBroadcasterName

Type: string

The name of the raided broadcaster.

raidingBroadcasterDisplayName

Type: string

The display name of the raiding broadcaster.

raidingBroadcasterId

Type: string

The ID of the raiding broadcaster.

raidingBroadcasterName

Type: string

The name of the raiding broadcaster.

viewers

Type: number

The amount of viewers in the raid.

Methods

getRaidedBroadcaster()

Gets more information about the raided broadcaster.

Return type: HelixUser

getRaidingBroadcaster()

Gets more information about the raiding broadcaster.

Return type: HelixUser