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

EventSubChannelRedemptionAddEvent

An EventSub event representing a Channel Points redemption.

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.

id

Type: string

The ID of the redemption.

input

Type: string

The input text given by the user.

If there is no input to be given, this is an empty string.

redeemedAt

Type: Date

The time when the user redeemed the reward.

rewardCost

Type: number

The cost of the reward that was redeemed.

rewardId

Type: string

The ID of the reward that was redeemed.

rewardPrompt

Type: string

The description of the reward that was redeemed.

rewardTitle

Type: string

The title of the reward that was redeemed.

status

Type: string

The status of the redemption.

userDisplayName

Type: string

The display name of the user.

userId

Type: string

The ID of the user.

userName

Type: string

The name of the user.

Methods

getBroadcaster()

async

Retrieves more information about the broadcaster.

Return type: HelixUser

getUser()

async

Retrieves more information about the user.

Return type: HelixUser