Twurple Authentication Getting data Examples FAQ Migration

Reference

api api-call auth auth-tmi chat common easy-bot ebs-helper eventsub-base eventsub-http eventsub-ws pubsub

Classes

EventSubAutoModMessageAutoMod EventSubAutoModMessageAutoModBoundary EventSubAutoModMessageBlockedTerm EventSubAutoModMessageHoldEvent EventSubAutoModMessageHoldV2Event EventSubAutoModMessageUpdateEvent EventSubAutoModMessageUpdateV2Event EventSubAutoModSettingsUpdateEvent EventSubAutoModTermsUpdateEvent EventSubChannelAdBreakBeginEvent EventSubChannelAutomaticRewardRedemptionAddEvent EventSubChannelAutoModTermsModerationEvent EventSubChannelBanEvent EventSubChannelBanModerationEvent EventSubChannelCharityAmount EventSubChannelCharityCampaignProgressEvent EventSubChannelCharityCampaignStartEvent EventSubChannelCharityCampaignStopEvent EventSubChannelCharityDonationEvent EventSubChannelChatAnnouncementNotificationEvent EventSubChannelChatBitsBadgeTierNotificationEvent EventSubChannelChatCharityDonationNotificationEvent EventSubChannelChatClearEvent EventSubChannelChatClearUserMessagesEvent EventSubChannelChatCommunitySubGiftNotificationEvent EventSubChannelChatGiftPaidUpgradeNotificationEvent EventSubChannelChatMessageDeleteEvent EventSubChannelChatMessageEvent EventSubChannelChatPayItForwardNotificationEvent EventSubChannelChatPrimePaidUpgradeNotificationEvent EventSubChannelChatRaidNotificationEvent EventSubChannelChatResubNotificationEvent EventSubChannelChatSettingsUpdateEvent EventSubChannelChatSharedChatAnnouncementNotificationEvent EventSubChannelChatSharedChatCommunitySubGiftNotificationEvent EventSubChannelChatSharedChatGiftPaidUpgradeNotificationEvent EventSubChannelChatSharedChatPayItForwardNotificationEvent EventSubChannelChatSharedChatPrimePaidUpgradeNotificationEvent EventSubChannelChatSharedChatRaidNotificationEvent EventSubChannelChatSharedChatResubNotificationEvent EventSubChannelChatSharedChatSubGiftNotificationEvent EventSubChannelChatSharedChatSubNotificationEvent EventSubChannelChatSubGiftNotificationEvent EventSubChannelChatSubNotificationEvent EventSubChannelChatUnraidNotificationEvent EventSubChannelChatUserMessageHoldEvent EventSubChannelChatUserMessageUpdateEvent EventSubChannelCheerEvent EventSubChannelClearModerationEvent EventSubChannelDeleteModerationEvent EventSubChannelEmoteOnlyModerationEvent EventSubChannelEmoteOnlyOffModerationEvent EventSubChannelFollowersModerationEvent EventSubChannelFollowersOffModerationEvent EventSubChannelFollowEvent EventSubChannelGoalBeginEvent EventSubChannelGoalEndEvent EventSubChannelGoalProgressEvent EventSubChannelHypeTrainBeginEvent EventSubChannelHypeTrainContribution EventSubChannelHypeTrainEndEvent EventSubChannelHypeTrainProgressEvent EventSubChannelModeratorEvent EventSubChannelModModerationEvent EventSubChannelPollBeginChoice EventSubChannelPollBeginEvent EventSubChannelPollChoice EventSubChannelPollEndEvent EventSubChannelPollProgressEvent EventSubChannelPredictionBeginEvent EventSubChannelPredictionBeginOutcome EventSubChannelPredictionEndEvent EventSubChannelPredictionLockEvent EventSubChannelPredictionOutcome EventSubChannelPredictionPredictor EventSubChannelPredictionProgressEvent EventSubChannelRaidEvent EventSubChannelRaidModerationEvent EventSubChannelRedemptionAddEvent EventSubChannelRedemptionUpdateEvent EventSubChannelRewardEvent EventSubChannelSharedChatBanModerationEvent EventSubChannelSharedChatDeleteModerationEvent EventSubChannelSharedChatSessionBeginEvent EventSubChannelSharedChatSessionEndEvent EventSubChannelSharedChatSessionParticipant EventSubChannelSharedChatSessionUpdateEvent EventSubChannelSharedChatTimeoutModerationEvent EventSubChannelSharedChatUnbanModerationEvent EventSubChannelSharedChatUntimeoutModerationEvent EventSubChannelShieldModeBeginEvent EventSubChannelShieldModeEndEvent EventSubChannelShoutoutCreateEvent EventSubChannelShoutoutReceiveEvent EventSubChannelSlowModerationEvent EventSubChannelSlowOffModerationEvent EventSubChannelSubscribersModerationEvent EventSubChannelSubscribersOffModerationEvent EventSubChannelSubscriptionEndEvent EventSubChannelSubscriptionEvent EventSubChannelSubscriptionGiftEvent EventSubChannelSubscriptionMessageEvent EventSubChannelSuspiciousUserMessageEvent EventSubChannelSuspiciousUserUpdateEvent EventSubChannelTimeoutModerationEvent EventSubChannelUnbanEvent EventSubChannelUnbanModerationEvent EventSubChannelUnbanRequestCreateEvent EventSubChannelUnbanRequestModerationEvent EventSubChannelUnbanRequestResolveEvent EventSubChannelUniqueChatModerationEvent EventSubChannelUniqueChatOffModerationEvent EventSubChannelUnmodModerationEvent EventSubChannelUnraidModerationEvent EventSubChannelUntimeoutModerationEvent EventSubChannelUnvipModerationEvent EventSubChannelUpdateEvent EventSubChannelVipEvent EventSubChannelVipModerationEvent EventSubChannelWarningAcknowledgeEvent EventSubChannelWarningSendEvent EventSubDropEntitlementGrantEvent EventSubExtensionBitsTransactionCreateEvent EventSubStreamOfflineEvent EventSubStreamOnlineEvent EventSubSubscription EventSubUserAuthorizationGrantEvent EventSubUserAuthorizationRevokeEvent EventSubUserUpdateEvent EventSubUserWhisperMessageEvent

Interfaces

EventSubBaseConfig EventSubListener

Type aliases

EventSubAutomaticRewardType EventSubAutoModLevel EventSubAutoModMessageHoldReason EventSubAutoModResolutionStatus EventSubAutoModTermsUpdateAction EventSubChannelAutomodTermsModerationEventAction EventSubChannelAutomodTermsModerationEventList EventSubChannelBanEvasionEvaluation EventSubChannelChatAnnouncementColor EventSubChannelChatNotificationEvent EventSubChannelChatNotificationSubTier EventSubChannelChatNotificationType EventSubChannelGoalType EventSubChannelHypeTrainContributionType EventSubChannelModerationAction EventSubChannelModerationEvent EventSubChannelPollEndStatus EventSubChannelPredictionColor EventSubChannelPredictionEndStatus EventSubChannelSubscriptionEndEventTier EventSubChannelSubscriptionEventTier EventSubChannelSubscriptionGiftEventTier EventSubChannelSubscriptionMessageEventTier EventSubChannelSuspiciousUserLowTrustStatus EventSubChannelSuspiciousUserType EventSubChannelUnbanRequestStatus EventSubStreamOnlineEventStreamType

EventSubChannelChatGiftPaidUpgradeNotificationEvent

An EventSub event representing a notification of a user upgrading their gifted sub to a paid one in a channel's chat.

Overview

Properties

Methods

getGiftera

Properties

gifterDisplayName

Type: string | null

The display name of the original gifter, or null if they're anonymous.

gifterId

Type: string | null

The ID of the original gifter, or null if they're anonymous.

gifterName

Type: string | null

The username of the original gifter, or null if they're anonymous.

isGifterAnonymous

Type: boolean

Whether the original gifter is anonymous.

type

Value: "gift_paid_upgrade"

Methods

getGifter()

Gets more information about the original gifter, or null if they're anonymous.

Return type: HelixUser | null