Skip to content

Interface: HypeTrainBeginEvent ​

Hype Train begin EventSub v2 payload.

Extends ​

Properties ​

all_time_high_level? ​

ts
optional all_time_high_level?: number;

all_time_high_total? ​

ts
optional all_time_high_total?: number;

broadcaster_user_id ​

ts
broadcaster_user_id: string;

Inherited from ​

HypeTrainProgressEvent.broadcaster_user_id


broadcaster_user_login ​

ts
broadcaster_user_login: string;

Inherited from ​

HypeTrainProgressEvent.broadcaster_user_login


broadcaster_user_name ​

ts
broadcaster_user_name: string;

Inherited from ​

HypeTrainProgressEvent.broadcaster_user_name


expires_at ​

ts
expires_at: string;

Inherited from ​

HypeTrainProgressEvent.expires_at


goal ​

ts
goal: number;

Inherited from ​

HypeTrainProgressEvent.goal


id ​

ts
id: string;

Inherited from ​

HypeTrainProgressEvent.id


is_shared_train ​

ts
is_shared_train: boolean;

Inherited from ​

HypeTrainProgressEvent.is_shared_train


last_contribution? ​

ts
optional last_contribution?: HypeTrainContribution;

Contribution that caused this progress notification, when supplied by Twitch.

Inherited from ​

HypeTrainProgressEvent.last_contribution


level ​

ts
level: number;

Inherited from ​

HypeTrainProgressEvent.level


progress ​

ts
progress: number;

Inherited from ​

HypeTrainProgressEvent.progress


shared_train_participants ​

ts
shared_train_participants: HypeTrainParticipant[];

Inherited from ​

HypeTrainProgressEvent.shared_train_participants


started_at ​

ts
started_at: string;

Inherited from ​

HypeTrainProgressEvent.started_at


top_contributions ​

ts
top_contributions: HypeTrainContribution[];

Inherited from ​

HypeTrainProgressEvent.top_contributions


total ​

ts
total: number;

Inherited from ​

HypeTrainProgressEvent.total


type ​

ts
type: string;

Inherited from ​

HypeTrainProgressEvent.type