TwurpleAuthenticationGetting dataExamplesFAQMigration
Reference
apiapi-callauthauth-tmichatcommoneasy-botebs-helpereventsub-baseeventsub-httpeventsub-wspubsub

Classes

EventSubAutoModMessageAutoModEventSubAutoModMessageAutoModBoundaryEventSubAutoModMessageBlockedTermEventSubAutoModMessageHoldEventEventSubAutoModMessageHoldV2EventEventSubAutoModMessageUpdateEventEventSubAutoModMessageUpdateV2EventEventSubAutoModSettingsUpdateEventEventSubAutoModTermsUpdateEventEventSubChannelAdBreakBeginEventEventSubChannelAutomaticRewardRedemptionAddEventEventSubChannelAutoModTermsModerationEventEventSubChannelBanEventEventSubChannelBanModerationEventEventSubChannelCharityAmountEventSubChannelCharityCampaignProgressEventEventSubChannelCharityCampaignStartEventEventSubChannelCharityCampaignStopEventEventSubChannelCharityDonationEventEventSubChannelChatAnnouncementNotificationEventEventSubChannelChatBitsBadgeTierNotificationEventEventSubChannelChatCharityDonationNotificationEventEventSubChannelChatClearEventEventSubChannelChatClearUserMessagesEventEventSubChannelChatCommunitySubGiftNotificationEventEventSubChannelChatGiftPaidUpgradeNotificationEventEventSubChannelChatMessageDeleteEventEventSubChannelChatMessageEventEventSubChannelChatPayItForwardNotificationEventEventSubChannelChatPrimePaidUpgradeNotificationEventEventSubChannelChatRaidNotificationEventEventSubChannelChatResubNotificationEventEventSubChannelChatSettingsUpdateEventEventSubChannelChatSharedChatAnnouncementNotificationEventEventSubChannelChatSharedChatCommunitySubGiftNotificationEventEventSubChannelChatSharedChatGiftPaidUpgradeNotificationEventEventSubChannelChatSharedChatPayItForwardNotificationEventEventSubChannelChatSharedChatPrimePaidUpgradeNotificationEventEventSubChannelChatSharedChatRaidNotificationEventEventSubChannelChatSharedChatResubNotificationEventEventSubChannelChatSharedChatSubGiftNotificationEventEventSubChannelChatSharedChatSubNotificationEventEventSubChannelChatSubGiftNotificationEventEventSubChannelChatSubNotificationEventEventSubChannelChatUnraidNotificationEventEventSubChannelChatUserMessageHoldEventEventSubChannelChatUserMessageUpdateEventEventSubChannelCheerEventEventSubChannelClearModerationEventEventSubChannelDeleteModerationEventEventSubChannelEmoteOnlyModerationEventEventSubChannelEmoteOnlyOffModerationEventEventSubChannelFollowersModerationEventEventSubChannelFollowersOffModerationEventEventSubChannelFollowEventEventSubChannelGoalBeginEventEventSubChannelGoalEndEventEventSubChannelGoalProgressEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainContributionEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelModModerationEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRaidModerationEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSharedChatBanModerationEventEventSubChannelSharedChatDeleteModerationEventEventSubChannelSharedChatSessionBeginEventEventSubChannelSharedChatSessionEndEventEventSubChannelSharedChatSessionParticipantEventSubChannelSharedChatSessionUpdateEventEventSubChannelSharedChatTimeoutModerationEventEventSubChannelSharedChatUnbanModerationEventEventSubChannelSharedChatUntimeoutModerationEventEventSubChannelShieldModeBeginEventEventSubChannelShieldModeEndEventEventSubChannelShoutoutCreateEventEventSubChannelShoutoutReceiveEventEventSubChannelSlowModerationEventEventSubChannelSlowOffModerationEventEventSubChannelSubscribersModerationEventEventSubChannelSubscribersOffModerationEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelSuspiciousUserMessageEventEventSubChannelSuspiciousUserUpdateEventEventSubChannelTimeoutModerationEventEventSubChannelUnbanEventEventSubChannelUnbanModerationEventEventSubChannelUnbanRequestCreateEventEventSubChannelUnbanRequestModerationEventEventSubChannelUnbanRequestResolveEventEventSubChannelUniqueChatModerationEventEventSubChannelUniqueChatOffModerationEventEventSubChannelUnmodModerationEventEventSubChannelUnraidModerationEventEventSubChannelUntimeoutModerationEventEventSubChannelUnvipModerationEventEventSubChannelUpdateEventEventSubChannelVipEventEventSubChannelVipModerationEventEventSubChannelWarningAcknowledgeEventEventSubChannelWarningSendEventEventSubDropEntitlementGrantEventEventSubExtensionBitsTransactionCreateEventEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationGrantEventEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventEventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfigEventSubListener

Type aliases

EventSubAutomaticRewardTypeEventSubAutoModLevelEventSubAutoModMessageHoldReasonEventSubAutoModResolutionStatusEventSubAutoModTermsUpdateActionEventSubChannelAutomodTermsModerationEventActionEventSubChannelAutomodTermsModerationEventListEventSubChannelBanEvasionEvaluationEventSubChannelChatAnnouncementColorEventSubChannelChatNotificationEventEventSubChannelChatNotificationSubTierEventSubChannelChatNotificationTypeEventSubChannelGoalTypeEventSubChannelHypeTrainContributionTypeEventSubChannelModerationActionEventSubChannelModerationEventEventSubChannelPollEndStatusEventSubChannelPredictionColorEventSubChannelPredictionEndStatusEventSubChannelSubscriptionEndEventTierEventSubChannelSubscriptionEventTierEventSubChannelSubscriptionGiftEventTierEventSubChannelSubscriptionMessageEventTierEventSubChannelSuspiciousUserLowTrustStatusEventSubChannelSuspiciousUserTypeEventSubChannelUnbanRequestStatusEventSubStreamOnlineEventStreamType

EventSubListener

The common interface of all EventSub listeners.

{
Subscribes to events that represent a chat message being held by AutoMod in a channel.
onAutoModMessageHold: (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: EventSubAutoModMessageHoldEvent) => void) => EventSubSubscription
Subscribes to events (v2) that represent a chat message being held by AutoMod in a channel.
onAutoModMessageHoldV2: (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: EventSubAutoModMessageHoldV2Event) => void) => EventSubSubscription
Subscribes to events that represent a held chat message by AutoMod being resolved in a channel.
onAutoModMessageUpdate: (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: EventSubAutoModMessageUpdateEvent) => void) => EventSubSubscription
Subscribes to events (v2) that represent a held chat message by AutoMod being resolved in a channel.
onAutoModMessageUpdateV2: (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: EventSubAutoModMessageUpdateV2Event) => void) => EventSubSubscription
Subscribes to events that represent the AutoMod settings being updated in a channel.
onAutoModSettingsUpdate: (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: EventSubAutoModSettingsUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent AutoMod terms being updated in a channel.
onAutoModTermsUpdate: (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: EventSubAutoModTermsUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent an ad break beginning in a channel.
onChannelAdBreakBegin: (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: EventSubChannelAdBreakBeginEvent) => void) => EventSubSubscription
Subscribes to events that represent a specific Channel Points automatic reward being redeemed.
onChannelAutomaticRewardRedemptionAdd: (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: EventSubChannelAutomaticRewardRedemptionAddEvent) => void) => EventSubSubscription
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 channel's chat being cleared.
onChannelChatClear: (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

, 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: EventSubChannelChatClearEvent) => void) => EventSubSubscription
Subscribes to events that represent a user's chat messages being cleared in a channel.
onChannelChatClearUserMessages: (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

, 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: EventSubChannelChatClearUserMessagesEvent) => void) => EventSubSubscription
Subscribes to events that represent a chat message being sent to a channel.
onChannelChatMessage: (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

, 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: EventSubChannelChatMessageEvent) => void) => EventSubSubscription
Subscribes to events that represent a chat message being deleted in a channel.
onChannelChatMessageDelete: (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

, 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: EventSubChannelChatMessageDeleteEvent) => void) => EventSubSubscription
Subscribes to events that represent a chat notification being sent to a channel.
onChannelChatNotification: (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

, 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:
EventSubChannelChatNotificationEvent

Aliased type: EventSubChannelChatSubNotificationEvent | EventSubChannelChatResubNotificationEvent | EventSubChannelChatSubGiftNotificationEvent | EventSubChannelChatCommunitySubGiftNotificationEvent | EventSubChannelChatGiftPaidUpgradeNotificationEvent | EventSubChannelChatPrimePaidUpgradeNotificationEvent | EventSubChannelChatRaidNotificationEvent | EventSubChannelChatUnraidNotificationEvent | EventSubChannelChatPayItForwardNotificationEvent | EventSubChannelChatAnnouncementNotificationEvent | EventSubChannelChatCharityDonationNotificationEvent | EventSubChannelChatBitsBadgeTierNotificationEvent | EventSubChannelChatSharedChatSubNotificationEvent | EventSubChannelChatSharedChatResubNotificationEvent | EventSubChannelChatSharedChatSubGiftNotificationEvent | EventSubChannelChatSharedChatCommunitySubGiftNotificationEvent | EventSubChannelChatSharedChatGiftPaidUpgradeNotificationEvent | EventSubChannelChatSharedChatPrimePaidUpgradeNotificationEvent | EventSubChannelChatSharedChatPayItForwardNotificationEvent | EventSubChannelChatSharedChatRaidNotificationEvent | EventSubChannelChatSharedChatAnnouncementNotificationEvent

) => void) => EventSubSubscription
Subscribes to events that represent chat settings being updated in a channel.
onChannelChatSettingsUpdate: (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

, 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: EventSubChannelChatSettingsUpdateEvent) => void) => EventSubSubscription
Subscribes to events that represent a user's notification about their chat message has been held by AutoMod.
onChannelChatUserMessageHold: (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

, 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: EventSubChannelChatUserMessageHoldEvent) => void) => EventSubSubscription
Subscribes to events that represent a user's notification about the resolution of a held chat message by AutoMod.
onChannelChatUserMessageUpdate: (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

, 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: EventSubChannelChatUserMessageUpdateEvent) => 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 moderator performing an action on a channel.
onChannelModerate: (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:
EventSubChannelModerationEvent

Aliased type: EventSubChannelAutoModTermsModerationEvent | EventSubChannelBanModerationEvent | EventSubChannelClearModerationEvent | EventSubChannelDeleteModerationEvent | EventSubChannelEmoteOnlyModerationEvent | EventSubChannelEmoteOnlyOffModerationEvent | EventSubChannelFollowersModerationEvent | EventSubChannelFollowersOffModerationEvent | EventSubChannelModModerationEvent | EventSubChannelRaidModerationEvent | EventSubChannelSlowModerationEvent | EventSubChannelSlowOffModerationEvent | EventSubChannelSubscribersModerationEvent | EventSubChannelSubscribersOffModerationEvent | EventSubChannelTimeoutModerationEvent | EventSubChannelUnbanModerationEvent | EventSubChannelUnbanRequestModerationEvent | EventSubChannelUniqueChatModerationEvent | EventSubChannelUniqueChatOffModerationEvent | EventSubChannelUnmodModerationEvent | EventSubChannelUnraidModerationEvent | EventSubChannelUntimeoutModerationEvent | EventSubChannelUnvipModerationEvent | EventSubChannelVipModerationEvent | EventSubChannelWarnModerationEvent | EventSubChannelSharedChatBanModerationEvent | EventSubChannelSharedChatUnbanModerationEvent | EventSubChannelSharedChatTimeoutModerationEvent | EventSubChannelSharedChatUntimeoutModerationEvent | EventSubChannelSharedChatDeleteModerationEvent

) => 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 indicate the start of a shared chat session in a channel.
onChannelSharedChatSessionBegin: (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

, handler: (data: EventSubChannelSharedChatSessionBeginEvent) => void) => EventSubSubscription
Subscribes to events that indicate the end of a shared chat session in a channel.
onChannelSharedChatSessionEnd: (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

, handler: (data: EventSubChannelSharedChatSessionEndEvent) => void) => EventSubSubscription
Subscribes to events that indicate updates to a shared chat session in a channel.
onChannelSharedChatSessionUpdate: (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

, handler: (data: EventSubChannelSharedChatSessionUpdateEvent) => 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 message sent by a suspicious user.
onChannelSuspiciousUserMessage: (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: EventSubChannelSuspiciousUserMessageEvent) => void) => EventSubSubscription
Subscribes to events that represent a suspicious user updated in a channel.
onChannelSuspiciousUserUpdate: (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: EventSubChannelSuspiciousUserUpdateEvent) => 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 that represent an unban request being created.
onChannelUnbanRequestCreate: (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: EventSubChannelUnbanRequestCreateEvent) => void) => EventSubSubscription
Subscribes to events that represent an unban request being resolved.
onChannelUnbanRequestResolve: (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: EventSubChannelUnbanRequestResolveEvent) => 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 user getting VIP status in a channel.
onChannelVipAdd: (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: EventSubChannelVipEvent) => void) => EventSubSubscription
Subscribes to events that represent a user losing VIP status in a channel.
onChannelVipRemove: (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: EventSubChannelVipEvent) => void) => EventSubSubscription
Subscribes to events that represent a warning being acknowledged by a user.
onChannelWarningAcknowledge: (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: EventSubChannelWarningAcknowledgeEvent) => void) => EventSubSubscription
Subscribes to events that represent a warning sent to a user.
onChannelWarningSend: (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: EventSubChannelWarningSendEvent) => 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
Subscribes to events that represent a user receiving a whisper message from another user.
onUserWhisperMessage: (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: EventSubUserWhisperMessageEvent) => void) => EventSubSubscription
Starts the listener.
start: () => void
Stops the listener.
stop: () => void
}

Properties

onAutoModMessageHold

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: EventSubAutoModMessageHoldEvent) => void) => EventSubSubscription

Subscribes to events that represent a chat message being held by AutoMod in a channel.

onAutoModMessageHoldV2

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: EventSubAutoModMessageHoldV2Event) => void) => EventSubSubscription

Subscribes to events (v2) that represent a chat message being held by AutoMod in a channel.

onAutoModMessageUpdate

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: EventSubAutoModMessageUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a held chat message by AutoMod being resolved in a channel.

onAutoModMessageUpdateV2

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: EventSubAutoModMessageUpdateV2Event) => void) => EventSubSubscription

Subscribes to events (v2) that represent a held chat message by AutoMod being resolved in a channel.

onAutoModSettingsUpdate

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: EventSubAutoModSettingsUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent the AutoMod settings being updated in a channel.

onAutoModTermsUpdate

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: EventSubAutoModTermsUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent AutoMod terms being updated in a channel.

onChannelAdBreakBegin

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: EventSubChannelAdBreakBeginEvent) => void) => EventSubSubscription

Subscribes to events that represent an ad break beginning in a channel.

onChannelAutomaticRewardRedemptionAdd

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: EventSubChannelAutomaticRewardRedemptionAddEvent) => void) => EventSubSubscription

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

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.

onChannelChatClear

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

, 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: EventSubChannelChatClearEvent) => void) => EventSubSubscription

Subscribes to events that represent a channel's chat being cleared.

onChannelChatClearUserMessages

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

, 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: EventSubChannelChatClearUserMessagesEvent) => void) => EventSubSubscription

Subscribes to events that represent a user's chat messages being cleared in a channel.

onChannelChatMessage

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

, 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: EventSubChannelChatMessageEvent) => void) => EventSubSubscription

Subscribes to events that represent a chat message being sent to a channel.

onChannelChatMessageDelete

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

, 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: EventSubChannelChatMessageDeleteEvent) => void) => EventSubSubscription

Subscribes to events that represent a chat message being deleted in a channel.

onChannelChatNotification

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

, 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:
EventSubChannelChatNotificationEvent

Aliased type: EventSubChannelChatSubNotificationEvent | EventSubChannelChatResubNotificationEvent | EventSubChannelChatSubGiftNotificationEvent | EventSubChannelChatCommunitySubGiftNotificationEvent | EventSubChannelChatGiftPaidUpgradeNotificationEvent | EventSubChannelChatPrimePaidUpgradeNotificationEvent | EventSubChannelChatRaidNotificationEvent | EventSubChannelChatUnraidNotificationEvent | EventSubChannelChatPayItForwardNotificationEvent | EventSubChannelChatAnnouncementNotificationEvent | EventSubChannelChatCharityDonationNotificationEvent | EventSubChannelChatBitsBadgeTierNotificationEvent | EventSubChannelChatSharedChatSubNotificationEvent | EventSubChannelChatSharedChatResubNotificationEvent | EventSubChannelChatSharedChatSubGiftNotificationEvent | EventSubChannelChatSharedChatCommunitySubGiftNotificationEvent | EventSubChannelChatSharedChatGiftPaidUpgradeNotificationEvent | EventSubChannelChatSharedChatPrimePaidUpgradeNotificationEvent | EventSubChannelChatSharedChatPayItForwardNotificationEvent | EventSubChannelChatSharedChatRaidNotificationEvent | EventSubChannelChatSharedChatAnnouncementNotificationEvent

) => void) => EventSubSubscription

Subscribes to events that represent a chat notification being sent to a channel.

onChannelChatSettingsUpdate

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

, 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: EventSubChannelChatSettingsUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent chat settings being updated in a channel.

onChannelChatUserMessageHold

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

, 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: EventSubChannelChatUserMessageHoldEvent) => void) => EventSubSubscription

Subscribes to events that represent a user's notification about their chat message has been held by AutoMod.

onChannelChatUserMessageUpdate

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

, 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: EventSubChannelChatUserMessageUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a user's notification about the resolution of a held chat message by AutoMod.

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.

onChannelModerate

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:
EventSubChannelModerationEvent

Aliased type: EventSubChannelAutoModTermsModerationEvent | EventSubChannelBanModerationEvent | EventSubChannelClearModerationEvent | EventSubChannelDeleteModerationEvent | EventSubChannelEmoteOnlyModerationEvent | EventSubChannelEmoteOnlyOffModerationEvent | EventSubChannelFollowersModerationEvent | EventSubChannelFollowersOffModerationEvent | EventSubChannelModModerationEvent | EventSubChannelRaidModerationEvent | EventSubChannelSlowModerationEvent | EventSubChannelSlowOffModerationEvent | EventSubChannelSubscribersModerationEvent | EventSubChannelSubscribersOffModerationEvent | EventSubChannelTimeoutModerationEvent | EventSubChannelUnbanModerationEvent | EventSubChannelUnbanRequestModerationEvent | EventSubChannelUniqueChatModerationEvent | EventSubChannelUniqueChatOffModerationEvent | EventSubChannelUnmodModerationEvent | EventSubChannelUnraidModerationEvent | EventSubChannelUntimeoutModerationEvent | EventSubChannelUnvipModerationEvent | EventSubChannelVipModerationEvent | EventSubChannelWarnModerationEvent | EventSubChannelSharedChatBanModerationEvent | EventSubChannelSharedChatUnbanModerationEvent | EventSubChannelSharedChatTimeoutModerationEvent | EventSubChannelSharedChatUntimeoutModerationEvent | EventSubChannelSharedChatDeleteModerationEvent

) => void) => EventSubSubscription

Subscribes to events that represent a moderator performing an action on a channel.

This requires the following scopes:

  • moderator:read:blocked_terms OR moderator:manage:blocked_terms
  • moderator:read:chat_settings OR moderator:manage:chat_settings
  • moderator:read:unban_requests OR moderator:manage:unban_requests
  • moderator:read:banned_users OR moderator:manage:banned_users
  • moderator:read:chat_messages OR moderator:manage:chat_messages
  • moderator:read:moderators
  • moderator:read:vips

These scope requirements cannot be checked by the library, so they are just assumed. Make sure to catch authorization errors yourself.

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.

onChannelSharedChatSessionBegin

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

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

Subscribes to events that indicate the start of a shared chat session in a channel.

onChannelSharedChatSessionEnd

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

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

Subscribes to events that indicate the end of a shared chat session in a channel.

onChannelSharedChatSessionUpdate

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

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

Subscribes to events that indicate updates to a shared chat session in a channel.

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.

onChannelSuspiciousUserMessage

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: EventSubChannelSuspiciousUserMessageEvent) => void) => EventSubSubscription

Subscribes to events that represent a message sent by a suspicious user.

onChannelSuspiciousUserUpdate

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: EventSubChannelSuspiciousUserUpdateEvent) => void) => EventSubSubscription

Subscribes to events that represent a suspicious user updated in a channel.

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.

onChannelUnbanRequestCreate

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: EventSubChannelUnbanRequestCreateEvent) => void) => EventSubSubscription

Subscribes to events that represent an unban request being created.

onChannelUnbanRequestResolve

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: EventSubChannelUnbanRequestResolveEvent) => void) => EventSubSubscription

Subscribes to events that represent an unban request being resolved.

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.

onChannelVipAdd

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: EventSubChannelVipEvent) => void) => EventSubSubscription

Subscribes to events that represent a user getting VIP status in a channel.

onChannelVipRemove

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: EventSubChannelVipEvent) => void) => EventSubSubscription

Subscribes to events that represent a user losing VIP status in a channel.

onChannelWarningAcknowledge

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: EventSubChannelWarningAcknowledgeEvent) => void) => EventSubSubscription

Subscribes to events that represent a warning being acknowledged by a user.

onChannelWarningSend

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: EventSubChannelWarningSendEvent) => void) => EventSubSubscription

Subscribes to events that represent a warning sent to a user.

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.

onUserWhisperMessage

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: EventSubUserWhisperMessageEvent) => void) => EventSubSubscription

Subscribes to events that represent a user receiving a whisper message from another user.

start

Type: () => void

Starts the listener.

stop

Type: () => void

Stops the listener.