TwurpleAuthenticationGetting dataExamplesFAQMigration

Classes

EventSubChannelAdBreakBeginEventEventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatSettingsUpdateEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

EventSubChannelShoutoutCreateEvent

An EventSub event representing a broadcaster shouting out another broadcaster.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster from whose channel the shoutout was sent.

broadcasterId

Type: string

The ID of the broadcaster from whose channel the shoutout was sent.

broadcasterName

Type: string

The name of the broadcaster from whose channel the shoutout was sent.

cooldownEndDate

Type: Date

The Date when the broadcaster may send a shoutout to a different broadcaster.

moderatorDisplayName

Type: string

The display name of the moderator who sent the shoutout.

moderatorId

Type: string

The ID of the moderator who sent the shoutout.

moderatorName

Type: string

The name of the moderator who sent the shoutout.

shoutedOutBroadcasterDisplayName

Type: string

The display name of the broadcaster who was shoutout out.

shoutedOutBroadcasterId

Type: string

The ID of the broadcaster who was shoutout out.

shoutedOutBroadcasterName

Type: string

The name of the broadcaster who was shoutout out.

startDate

Type: Date

The Date when the shoutout was sent.

targetCooldownEndDate

Type: Date

The Date when the broadcaster may send another shoutout to the same broadcaster.

viewerCount

Type: number

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

Methods

getBroadcaster()

async

Gets more information about the broadcaster from whose channel the shoutout was sent.

Return type: HelixUser

getModerator()

async

Gets more information about the moderator who sent the shoutout.

Return type: HelixUser

getShoutedOutBroadcaster()

async

Gets more information about the broadcaster who was shoutout out.

Return type: HelixUser