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

Core functionality

BotBotCommandBotCommandContext

Events

AnnouncementEventBanEventBitsBadgeUpgradeEventChatClearEventCommunityPayForwardEventCommunitySubEventEmoteOnlyToggleEventFollowersOnlyToggleEventGiftPaidUpgradeEventJoinEventJoinFailureEventLeaveEventMessageEventMessageRemoveEventPrimePaidUpgradeEventRaidCancelEventRaidEventSlowModeToggleEventStandardPayForwardEventSubEventSubGiftEventSubsOnlyToggleEventUniqueChatToggleEventWhisperEvent

Functions

createBotCommand

Interfaces

BotConfigCreateBotCommandOptions

Type aliases

BotAuthMethodChatAnnouncementColor

StandardPayForwardEvent

An event representing a user gifting a subscription to a specific user in a channel in response to getting one gifted.

Overview

Properties

Methods

Properties

broadcasterId

Type: string

The ID of the broadcaster.

broadcasterName

Type: string

The name of the broadcaster.

gifterDisplayName

Type: string

The display name of the user who sent the new gift.

gifterId

Type: string

The ID of the user who sent the new gift.

gifterName

Type: string

The name of the user who sent the new gift.

messageObject

Type: UserNotice

The full object that contains all the message information.

originalGifterDisplayName

Type: string | null

The display name of the user who sent the original gift, or null if they were anonymous.

originalGifterId

Type: string | null

The ID of the user who sent the original gift, or null if they were anonymous.

userDisplayName

Type: string

The display name of the recipient of the gift.

userId

Type: string

The ID of the recipient of the gift.

Methods

getBroadcaster()

async

Gets more information about the broadcaster.

Return type: HelixUser

getGifter()

async

Gets more information about the user who sent the new gift.

Return type: HelixUser

getOriginalGifter()

async

Gets more information about the user who sent the original gift, or null if they were anonymous.

Return type: HelixUser | null

getUser()

async

Gets more information about the recipient of the gift.

Return type: HelixUser