HelixHypeTrainEvent

broadcasterId

Type: string

The user ID of the broadcaster where the Hype Train event was triggered.

cooldownDate

Type: Date

The time when the Hype Train cooldown will end.

eventDate

Type: Date

The date of the Hype Train event.

eventId

Type: string

The unique ID of the Hype Train event.

eventType

Type:

HelixHypeTrainEventType

The different types a Hype Train event can have.

Aliased type: "hypetrain.progression"

The type of the Hype Train event.

eventVersion

Type: string

The version of the Hype Train event.

expiryDate

Type: Date

The time when the Hype Train is set to expire.

goal

Type: number

The progress points goal to reach the next Hype Train level.

id

Type: string

The unique ID of the Hype Train.

lastContribution

Type: HelixHypeTrainContribution

The last contribution to the Hype Train event.

level

Type: number

The level of the Hype Train event.

startDate

Type: Date

The time when the Hype Train started.

topContributions

Type: Array<HelixHypeTrainContribution>

Array list of the top contributions to the Hype Train event for bits and subs.

total

Type: number

The total amount of progress points of the Hype Train event.

getBroadcaster()

Retrieves more information about the broadcaster where the Hype Train event was triggered.