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

EventSubChannelShoutoutReceiveEvent

An EventSub event representing a broadcaster being shouted out by another broadcaster.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster who received the shoutout.

broadcasterId

Type: string

The ID of the broadcaster who received the shoutout.

broadcasterName

Type: string

The name of the broadcaster who received the shoutout.

shoutingOutBroadcasterDisplayName

Type: string

The display name of the broadcaster who sent the shoutout.

shoutingOutBroadcasterId

Type: string

The ID of the broadcaster who sent the shoutout.

shoutingOutBroadcasterName

Type: string

The name of the broadcaster who sent the shoutout.

startDate

Type: Date

The Date when the shoutout was sent.

viewerCount

Type: number

The amount of viewers who were watching the sending broadcaster's stream at the time of the shoutout.

Methods

getBroadcaster()

Gets more information about the broadcaster who received the shoutout.

Return type: HelixUser

getShoutingOutBroadcaster()

Gets more information about the broadcaster who sent the shoutout.

Return type: HelixUser