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

Basic usage

Getting startedListening to events

Special hosting

Serving through a reverse proxyTesting locally using ngrok

Classes

ConnectionAdapterDirectConnectionAdapterEnvPortAdapterEventSubChannelBanEventEventSubChannelCheerEventEventSubChannelFollowEventEventSubChannelHypeTrainBeginEventEventSubChannelHypeTrainEndEventEventSubChannelHypeTrainProgressEventEventSubChannelModeratorEventEventSubChannelPollBeginChoiceEventSubChannelPollBeginEventEventSubChannelPollChoiceEventSubChannelPollEndEventEventSubChannelPollProgressEventEventSubChannelPredictionBeginEventEventSubChannelPredictionBeginOutcomeEventSubChannelPredictionEndEventEventSubChannelPredictionLockEventEventSubChannelPredictionOutcomeEventSubChannelPredictionPredictorEventSubChannelPredictionProgressEventEventSubChannelRaidEventEventSubChannelRedemptionAddEventEventSubChannelRedemptionUpdateEventEventSubChannelRewardEventEventSubChannelSubscriptionEndEventEventSubChannelSubscriptionEventEventSubChannelSubscriptionGiftEventEventSubChannelSubscriptionMessageEventEventSubChannelUnbanEventEventSubChannelUpdateEventEventSubExtensionBitsTransactionCreateEventEventSubListenerEventSubMiddlewareEventSubStreamOfflineEventEventSubStreamOnlineEventEventSubSubscriptionEventSubUserAuthorizationRevokeEventEventSubUserUpdateEventMiddlewareAdapterReverseProxyAdapter

Interfaces

ConnectCompatibleAppDirectConnectionAdapterConfigEnvPortAdapterConfigEventSubConfigEventSubListenerCertificateConfigEventSubMiddlewareConfigMiddlewareAdapterConfigReverseProxyAdapterConfig

EventSubChannelSubscriptionEvent

An EventSub event representing a channel subscription.

Overview

Properties

Methods

Properties

broadcasterDisplayName

Type: string

The display name of the broadcaster.

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

isGift

Type: boolean

Whether the subscription has been gifted.

tier

Type:
EventSubChannelSubscriptionEventTier

The tier of a subscription. 1000 means tier 1, and so on.

Aliased type: "1000" | "2000" | "3000"

The tier of the subscription, either 1000, 2000 or 3000.

userDisplayName

Type: string

The display name of the subscribing user.

userId

Type: string

The ID of the subscribing user.

userName

Type: string

The name of the subscribing user.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser

getUser()

async

Retrieves more information about the subscribing user.

Return type: HelixUser