twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

EventSubChannelHypeTrainEndEvent

An EventSub event representing the end of a Hype train event.

Overview

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

cooldownEndDate

Type: Date

The time when the Hype Train cooldown ends.

endDate

Type: Date

The time when the Hype Train ended.

id

Type: string

The ID of the Hype Train.

level

Type: number

The level the Hype Train ended on.

startDate

Type: Date

The time when the Hype Train started.

topContributions

Type: Array<EventSubChannelHypeTrainContribution>

The contributors with the most points, for both bits and subscriptions.

total

Type: number

The total points contributed to the Hype Train.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser