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

EventSubExtensionBitsTransactionCreateEvent

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.

clientId

Type: string

The client ID of the extension.

id

Type: string

The ID of the transaction.

productCost

Type: number

The cost of the product the transaction is referring to, in Bits.

productInDevelopment

Type: boolean

Whether the product the transaction is referring to is in development.

productName

Type: string

The name of the product the transaction is referring to.

productSku

Type: string

The SKU of the product the transaction is referring to.

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