TwurpleAuthenticationGetting dataExamplesFAQMigration

Classes

EventSubChannelAdBreakBeginEventEventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatSettingsUpdateEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

EventSubChannelShoutoutReceiveEvent

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

Overview

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()

async

Gets more information about the broadcaster who received the shoutout.

Return type: HelixUser

getShoutingOutBroadcaster()

async

Gets more information about the broadcaster who sent the shoutout.

Return type: HelixUser