TwurpleAuthenticationGetting dataExamplesFAQMigration

Classes

EventSubChannelBanEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEvent

EventSubListener

The common interface of all EventSub listeners.

{
Subscribes to events that represent a user getting banned from a channel.
onChannelBan: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelBanEvent) => void) => EventSubSubscription
Subscribes to events that represent progress in a charity campaign in a channel.
onChannelCharityCampaignProgress: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignProgressEvent) => void) => EventSubSubscription
Subscribes to events that represent a charity campaign starting in a channel.
onChannelCharityCampaignStart: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignStartEvent) => void) => EventSubSubscription
Subscribes to events that represent a charity campaign ending in a channel.
onChannelCharityCampaignStop: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignStopEvent) => void) => EventSubSubscription
Subscribes to events that represent a donation to a charity campaign in a channel.
onChannelCharityDonation: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityDonationEvent) => void) => EventSubSubscription
Subscribes to events that represent a user cheering some bits.
onChannelCheer: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCheerEvent) => void) => EventSubSubscription
Subscribes to events that represent a user following a channel.
onChannelFollow: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelFollowEvent) => void) => EventSubSubscription
Subscribes to events that represent a Goal beginning.
onChannelGoalBegin: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent the end of a Goal in a channel.
onChannelGoalEnd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalEndEvent) => void) => EventSubSubscription
Subscribes to events that represent progress in a Goal in a channel.
onChannelGoalProgress: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalProgressEvent) => void) => EventSubSubscription
Subscribes to events that represent a Hype Train beginning.
onChannelHypeTrainBegin: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent the end of a Hype Train in a channel.
onChannelHypeTrainEnd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainEndEvent) => void) => EventSubSubscription
Subscribes to events that represent progress in a Hype Train in a channel.
onChannelHypeTrainProgress: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainProgressEvent) => void) => EventSubSubscription
Subscribes to events that represent a user getting moderator permissions in a channel.
onChannelModeratorAdd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelModeratorEvent) => void) => EventSubSubscription
Subscribes to events that represent a user losing moderator permissions in a channel.
onChannelModeratorRemove: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelModeratorEvent) => void) => EventSubSubscription
Subscribes to events that represent a poll starting in a channel.
onChannelPollBegin: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent a poll ending in a channel.
onChannelPollEnd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollEndEvent) => void) => EventSubSubscription
Subscribes to events that represent a poll being voted on in a channel.
onChannelPollProgress: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollProgressEvent) => void) => EventSubSubscription
Subscribes to events that represent a prediction starting in a channel.
onChannelPredictionBegin: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent a prediction ending in a channel.
onChannelPredictionEnd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionEndEvent) => void) => EventSubSubscription
Subscribes to events that represent a prediction being locked in a channel.
onChannelPredictionLock: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionLockEvent) => void) => EventSubSubscription
Subscribes to events that represent a prediction being voted on in a channel.
onChannelPredictionProgress: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionProgressEvent) => void) => EventSubSubscription
Subscribes to events that represent a broadcaster raiding another broadcaster.
onChannelRaidFrom: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelRaidEvent) => void) => EventSubSubscription
Subscribes to events that represent a broadcaster being raided by another broadcaster.
onChannelRaidTo: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelRaidEvent) => void) => EventSubSubscription
Subscribes to events that represents a Channel Points reward being redeemed.
onChannelRedemptionAdd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRedemptionAddEvent) => void) => EventSubSubscription
Subscribes to events that represent a specific Channel Points reward being redeemed.
onChannelRedemptionAddForReward: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRedemptionAddEvent) => void) => EventSubSubscription
Subscribes to events that represent a Channel Points reward being updated by a broadcaster.
onChannelRedemptionUpdate: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRedemptionUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent a specific Channel Points reward being updated by a broadcaster.
onChannelRedemptionUpdateForReward: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRedemptionUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent a Channel Points reward being added to a channel.
onChannelRewardAdd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription
Subscribes to events that represent a Channel Points reward being removed.
onChannelRewardRemove: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription
Subscribes to events that represent a specific Channel Points reward being removed.
onChannelRewardRemoveForReward: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription
Subscribes to events that represent a Channel Points reward being updated.
onChannelRewardUpdate: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription
Subscribes to events that represent a specific Channel Points reward being updated.
onChannelRewardUpdateForReward: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription
Subscribes to events that represent Shield Mode being activated in a channel.
onChannelShieldModeBegin: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelShieldModeBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent Shield Mode being deactivated in a channel.
onChannelShieldModeEnd: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelShieldModeEndEvent) => void) => EventSubSubscription
Subscribes to events that represent a broadcaster shouting out another broadcaster.
onChannelShoutoutCreate: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelShoutoutCreateEvent) => void) => EventSubSubscription
Subscribes to events that represent a broadcaster being shouted out by another broadcaster.
onChannelShoutoutReceive: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelShoutoutReceiveEvent) => void) => EventSubSubscription
Subscribes to events that represent a user subscribing to a channel.
onChannelSubscription: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionEvent) => void) => EventSubSubscription
Subscribes to events that represent a user's subscription to a channel ending.
onChannelSubscriptionEnd: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionEndEvent) => void) => EventSubSubscription
Subscribes to events that represent a user gifting a subscription to a channel to someone else.
onChannelSubscriptionGift: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionGiftEvent) => void) => EventSubSubscription
Subscribes to events that represent a user's subscription to a channel being announced.
onChannelSubscriptionMessage: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionMessageEvent) => void) => EventSubSubscription
Subscribes to events that represent a user getting unbanned from a channel.
onChannelUnban: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelUnbanEvent) => void) => EventSubSubscription
Subscribes to events representing a change in channel metadata, e.g. stream title or category.
onChannelUpdate: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent a drop entitlement being granted.
Subscribes to events that represent a Bits transaction in an extension.
Subscribes to events representing a stream going offline.
onStreamOffline: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubStreamOfflineEvent) => void) => EventSubSubscription
Subscribes to events representing a stream going live.
onStreamOnline: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubStreamOnlineEvent) => void) => EventSubSubscription
Subscribes to events that represent a user granting authorization to an application.
Subscribes to events that represent a user revoking authorization from an application.
Subscribes to events that represent a user updating their account details.
onUserUpdate: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubUserUpdateEvent) => void) => EventSubSubscription
Starts the listener.
start: () => void
Stops the listener.
stop: () => void
}

Properties

onChannelBan

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelBanEvent) => void) => EventSubSubscription

Subscribes to events that represent a user getting banned from a channel.

onChannelCharityCampaignProgress

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignProgressEvent) => void) => EventSubSubscription

Subscribes to events that represent progress in a charity campaign in a channel.

onChannelCharityCampaignStart

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignStartEvent) => void) => EventSubSubscription

Subscribes to events that represent a charity campaign starting in a channel.

onChannelCharityCampaignStop

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityCampaignStopEvent) => void) => EventSubSubscription

Subscribes to events that represent a charity campaign ending in a channel.

onChannelCharityDonation

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCharityDonationEvent) => void) => EventSubSubscription

Subscribes to events that represent a donation to a charity campaign in a channel.

onChannelCheer

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelCheerEvent) => void) => EventSubSubscription

Subscribes to events that represent a user cheering some bits.

onChannelFollow

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelFollowEvent) => void) => EventSubSubscription

Subscribes to events that represent a user following a channel.

onChannelGoalBegin

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent a Goal beginning.

onChannelGoalEnd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalEndEvent) => void) => EventSubSubscription

Subscribes to events that represent the end of a Goal in a channel.

onChannelGoalProgress

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelGoalProgressEvent) => void) => EventSubSubscription

Subscribes to events that represent progress in a Goal in a channel.

onChannelHypeTrainBegin

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent a Hype Train beginning.

onChannelHypeTrainEnd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainEndEvent) => void) => EventSubSubscription

Subscribes to events that represent the end of a Hype Train in a channel.

onChannelHypeTrainProgress

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelHypeTrainProgressEvent) => void) => EventSubSubscription

Subscribes to events that represent progress in a Hype Train in a channel.

onChannelModeratorAdd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelModeratorEvent) => void) => EventSubSubscription

Subscribes to events that represent a user getting moderator permissions in a channel.

onChannelModeratorRemove

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelModeratorEvent) => void) => EventSubSubscription

Subscribes to events that represent a user losing moderator permissions in a channel.

onChannelPollBegin

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent a poll starting in a channel.

onChannelPollEnd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollEndEvent) => void) => EventSubSubscription

Subscribes to events that represent a poll ending in a channel.

onChannelPollProgress

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPollProgressEvent) => void) => EventSubSubscription

Subscribes to events that represent a poll being voted on in a channel.

onChannelPredictionBegin

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent a prediction starting in a channel.

onChannelPredictionEnd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionEndEvent) => void) => EventSubSubscription

Subscribes to events that represent a prediction ending in a channel.

onChannelPredictionLock

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionLockEvent) => void) => EventSubSubscription

Subscribes to events that represent a prediction being locked in a channel.

onChannelPredictionProgress

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelPredictionProgressEvent) => void) => EventSubSubscription

Subscribes to events that represent a prediction being voted on in a channel.

onChannelRaidFrom

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelRaidEvent) => void) => EventSubSubscription

Subscribes to events that represent a broadcaster raiding another broadcaster.

onChannelRaidTo

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelRaidEvent) => void) => EventSubSubscription

Subscribes to events that represent a broadcaster being raided by another broadcaster.

onChannelRedemptionAdd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRedemptionAddEvent) => void) => EventSubSubscription

Subscribes to events that represents a Channel Points reward being redeemed.

onChannelRedemptionAddForReward

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRedemptionAddEvent) => void) => EventSubSubscription

Subscribes to events that represent a specific Channel Points reward being redeemed.

onChannelRedemptionUpdate

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRedemptionUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a Channel Points reward being updated by a broadcaster.

onChannelRedemptionUpdateForReward

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRedemptionUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a specific Channel Points reward being updated by a broadcaster.

onChannelRewardAdd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription

Subscribes to events that represent a Channel Points reward being added to a channel.

onChannelRewardRemove

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription

Subscribes to events that represent a Channel Points reward being removed.

onChannelRewardRemoveForReward

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription

Subscribes to events that represent a specific Channel Points reward being removed.

onChannelRewardUpdate

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription

Subscribes to events that represent a Channel Points reward being updated.

onChannelRewardUpdateForReward

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, rewardId: string, handler: (data: EventSubChannelRewardEvent) => void) => EventSubSubscription

Subscribes to events that represent a specific Channel Points reward being updated.

onChannelShieldModeBegin

Type: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelShieldModeBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent Shield Mode being activated in a channel.

onChannelShieldModeEnd

Type: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelShieldModeEndEvent) => void) => EventSubSubscription

Subscribes to events that represent Shield Mode being deactivated in a channel.

onChannelShoutoutCreate

Type: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelShoutoutCreateEvent) => void) => EventSubSubscription

Subscribes to events that represent a broadcaster shouting out another broadcaster.

onChannelShoutoutReceive

Type: (broadcaster:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, moderator:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubChannelShoutoutReceiveEvent) => void) => EventSubSubscription

Subscribes to events that represent a broadcaster being shouted out by another broadcaster.

onChannelSubscription

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionEvent) => void) => EventSubSubscription

Subscribes to events that represent a user subscribing to a channel.

onChannelSubscriptionEnd

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionEndEvent) => void) => EventSubSubscription

Subscribes to events that represent a user's subscription to a channel ending.

onChannelSubscriptionGift

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionGiftEvent) => void) => EventSubSubscription

Subscribes to events that represent a user gifting a subscription to a channel to someone else.

onChannelSubscriptionMessage

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelSubscriptionMessageEvent) => void) => EventSubSubscription

Subscribes to events that represent a user's subscription to a channel being announced.

onChannelUnban

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelUnbanEvent) => void) => EventSubSubscription

Subscribes to events that represent a user getting unbanned from a channel.

onChannelUpdate

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubChannelUpdateEvent) => void) => EventSubSubscription

Subscribes to events representing a change in channel metadata, e.g. stream title or category.

onDropEntitlementGrant

Type: (filter: HelixEventSubDropEntitlementGrantFilter, handler: (event: EventSubDropEntitlementGrantEvent) => void) => EventSubSubscription

Subscribes to events that represent a drop entitlement being granted.

onExtensionBitsTransactionCreate

Type: (handler: (event: EventSubExtensionBitsTransactionCreateEvent) => void) => EventSubSubscription

Subscribes to events that represent a Bits transaction in an extension.

onStreamOffline

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubStreamOfflineEvent) => void) => EventSubSubscription

Subscribes to events representing a stream going offline.

onStreamOnline

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (event: EventSubStreamOnlineEvent) => void) => EventSubSubscription

Subscribes to events representing a stream going live.

onUserAuthorizationGrant

Type: (handler: (data: EventSubUserAuthorizationGrantEvent) => void) => EventSubSubscription

Subscribes to events that represent a user granting authorization to an application.

onUserAuthorizationRevoke

Type: (handler: (data: EventSubUserAuthorizationRevokeEvent) => void) => EventSubSubscription

Subscribes to events that represent a user revoking authorization from an application.

onUserUpdate

Type: (user:
UserIdResolvable

A user ID or a user or channel object.

This is not a user name. Please use HelixUserApi#getUserByName to fetch a user object by name.

Aliased type: string | number | UserIdResolvableType

, handler: (data: EventSubUserUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a user updating their account details.

start

Type: () => void

Starts the listener.

stop

Type: () => void

Stops the listener.