HelixEventSubApi

The API methods that deal with WebHooks.

Overview

Methods

Can be accessed using client.helix.eventSub on an ApiClient instance.

Before using these methods...

All of the methods in this class assume that you are already running a working EventSub listener at the given callback URL.

If you don't already have one, we recommend use of the twitch-eventsub library, which handles subscribing and unsubscribing to these topics automatically.

Example

const api = new ApiClient(new StaticAuthProvider(clientId, accessToken));
await api.helix.eventSub.subscribeToUserFollowsTo('125328655', { callbackUrl: 'https://example.com' });

Methods

createSubscription(type, version, condition, transport)

async

Sends an arbitrary request to subscribe to an event.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Default	Description
type	string	none	The type of the event.
version	string	none	The version of the event.
condition	Record<string, unknown>	none	The condition of the subscription.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	none	The transport of the subscription.

Return type: HelixEventSubSubscription

deleteAllSubscriptions()

async

Deletes all subscriptions.

Return type: void

deleteBrokenSubscriptions()

async

Deletes all broken subscriptions, i.e. all that are not enabled or pending verification.

Return type: void

deleteSubscription(id)

async

Deletes a subscription.

Parameter	Type	Required	Default	Description
id	string		none	The ID of the subscription.

Return type: void

getSubscriptions(pagination)

async

Retrieves the current WebHook subscriptions for the current client.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Default	Description
pagination	HelixPagination	none
pagination.after	string	none	A cursor to get the following page of.
pagination.before	string	none	A cursor to get the previous page of.
pagination.limit	string	none	The number of results per page.

Return type: HelixPaginatedResultWithTotal<HelixEventSubSubscription>

getSubscriptionsForStatus(status, pagination)

async

Retrieves the current WebHook subscriptions with the given status for the current client.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Default	Description
status	HelixEventSubSubscriptionStatus Aliased type: "enabled" \| "webhook_callback_verification_pending" \| "webhook_callback_verification_failed" \| "notification_failures_exceeded" \| "authorization_revoked" \| "user_removed"	none	The status of the subscriptions to retrieve.
pagination	HelixPagination	none
pagination.after	string	none	A cursor to get the following page of.
pagination.before	string	none	A cursor to get the previous page of.
pagination.limit	string	none	The number of results per page.

Return type: HelixPaginatedResultWithTotal<HelixEventSubSubscription>

getSubscriptionsForStatusPaginated(status)

Creates a paginator for the current WebHook subscriptions with the given status for the current client.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Required	Default	Description
status	HelixEventSubSubscriptionStatus Aliased type: "enabled" \| "webhook_callback_verification_pending" \| "webhook_callback_verification_failed" \| "notification_failures_exceeded" \| "authorization_revoked" \| "user_removed"		none	The status of the subscriptions to retrieve.

Return type: HelixPaginatedRequestWithTotal<HelixEventSubSubscriptionData, HelixEventSubSubscription>

getSubscriptionsForType(type, pagination)

async

Retrieves the current WebHook subscriptions with the given type for the current client.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Default	Description
type	string	none	The type of the subscriptions to retrieve.
pagination	HelixPagination	none
pagination.after	string	none	A cursor to get the following page of.
pagination.before	string	none	A cursor to get the previous page of.
pagination.limit	string	none	The number of results per page.

Return type: HelixPaginatedResultWithTotal<HelixEventSubSubscription>

getSubscriptionsForTypePaginated(type)

Creates a paginator for the current WebHook subscriptions with the given type for the current client.

Requires an app access token to work; does not work with user tokens.

Parameter	Type	Required	Default	Description
type	string		none	The type of the subscriptions to retrieve.

Return type: HelixPaginatedRequestWithTotal<HelixEventSubSubscriptionData, HelixEventSubSubscription>

getSubscriptionsPaginated()

Creates a paginator for the current WebHook subscriptions for the current client.

Requires an app access token to work; does not work with user tokens.

Return type: HelixPaginatedRequestWithTotal<HelixEventSubSubscriptionData, HelixEventSubSubscription>

subscribeToChannelBanEvents(broadcaster, transport)

async

Subscribe to events that represent a user being banned in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to ban events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport option.

Return type: HelixEventSubSubscription

subscribeToChannelCheerEvents(broadcaster, transport)

async

Subscribe to events that represent a user cheering bits to a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to cheer events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelFollowEvents(broadcaster, transport)

async

Subscribe to events that represent a user following a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to follow events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToChannelHypeTrainBeginEvents(broadcaster, transport)

async

Subscribe to events that represent the beginning of a Hype Train event in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to Hype train begin events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelHypeTrainEndEvents(broadcaster, transport)

async

Subscribe to events that represent the end of a Hype Train event.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster for which you want to listen to Hype Train end events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelHypeTrainProgressEvents(broadcaster, transport)

async

Subscribe to events that represent progress towards the Hype Train goal.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster for which you want to listen to Hype Train progress events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelModeratorAddEvents(broadcaster, transport)

async

Subscribe to events that represent a moderator being added to a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen for moderator add events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelModeratorRemoveEvents(broadcaster, transport)

async

Subscribe to events that represent a moderator being removed from a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen for moderator remove events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPollBeginEvents(broadcaster, transport)

async

Subscribe to events that represent a poll starting in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to poll begin events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPollEndEvents(broadcaster, transport)

async

Subscribe to events that represent a poll ending in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to poll end events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPollProgressEvents(broadcaster, transport)

async

Subscribe to events that represent a poll being voted on in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to poll progress events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPredictionBeginEvents(broadcaster, transport)

async

Subscribe to events that represent a prediction starting in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to prediction begin events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPredictionEndEvents(broadcaster, transport)

async

Subscribe to events that represent a prediction ending in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to prediction end events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPredictionLockEvents(broadcaster, transport)

async

Subscribe to events that represent a prediction being locked in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to prediction lock events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelPredictionProgressEvents(broadcaster, transport)

async

Subscribe to events that represent a prediction being voted on in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to prediction preogress events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRaidEventsFrom(broadcaster, transport)

async

Subscribe to events that represent a broadcaster raiding another broadcaster.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to outgoing raid events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRaidEventsTo(broadcaster, transport)

async

Subscribe to events that represent a broadcaster being raided by another broadcaster.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to incoming raid events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionAddEvents(broadcaster, transport)

async

Subscribe to events that represent a Channel Points reward being redeemed.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to redemption events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionAddEventsForReward(broadcaster, rewardId, transport)

async

Subscribe to events that represent a specific Channel Points reward being redeemed.

Parameter	Type	Default	Description
broadcaster	UserIdResolvable	none	The broadcaster you want to listen to redemption events for.
rewardId	string	none	The ID of the reward you want to listen to redemption events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionUpdateEvents(broadcaster, transport)

async

Subscribe to events that represent a Channel Points redemption being updated.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to redemption update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionUpdateEventsForReward(broadcaster, rewardId, transport)

async

Subscribe to events that represent a specific Channel Points reward's redemption being updated.

Parameter	Type	Default	Description
broadcaster	UserIdResolvable	none	The broadcaster you want to listen to redemption update events for.
rewardId	string	none	The ID of the reward you want to listen to redemption updates for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRewardAddEvents(broadcaster, transport)

async

Subscribe to events that represent a Channel Points reward being added to a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to reward add events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRewardRemoveEvents(broadcaster, transport)

async

Subscribe to events that represent a Channel Points reward being removed from a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to reward remove events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRewardRemoveEventsForReward(broadcaster, rewardId, transport)

async

Subscribe to events that represent a specific Channel Points reward being removed from a channel.

Parameter	Type	Default	Description
broadcaster	UserIdResolvable	none	The broadcaster you want to listen to reward remove events for.
rewardId	string	none	The ID of the reward you want to listen to remove events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRewardUpdateEvents(broadcaster, transport)

async

Subscribe to events that represent a Channel Points reward being updated in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to reward update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRewardUpdateEventsForReward(broadcaster, rewardId, transport)

async

Subscribe to events that represent a specific Channel Points reward being updated.

Parameter	Type	Default	Description
broadcaster	UserIdResolvable	none	The broadcaster you want to listen to reward update events for.
rewardId	string	none	The ID of the reward you want to listen to update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelSubscriptionEndEvents(broadcaster, transport)

async

Subscribe to events that represent a user's subscription to a channel ending.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to subscription end events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToChannelSubscriptionEvents(broadcaster, transport)

async

Subscribe to events that represent a user subscribing to a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to subscribe events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToChannelSubscriptionGiftEvents(broadcaster, transport)

async

Subscribe to events that represent a user gifting another user a subscription to a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to subscription gift events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToChannelSubscriptionMessageEvents(broadcaster, transport)

async

Subscribe to events that represent a user's subscription to a channel being announced.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to subscription message events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToChannelUnbanEvents(broadcaster, transport)

async

Subscribe to events that represent a user being unbanned in a channel.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to unban events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelUpdateEvents(broadcaster, transport)

async

Subscribe to events that represent a channel updating their metadata.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToExtensionBitsTransactionCreateEvents(clientId, transport)

async

Subscribe to events that represent a extension Bits transaction.

Parameter	Type	Required	Default	Description
clientId	string		none	The Client ID for the extension you want to listen to Bits transactions for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToStreamOfflineEvents(broadcaster, transport)

async

Subscribe to events that represent a stream going offline.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to online events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToStreamOnlineEvents(broadcaster, transport)

async

Subscribe to events that represent a stream going live.

Parameter	Type	Required	Default	Description
broadcaster	UserIdResolvable		none	The broadcaster you want to listen to online events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options

Return type: HelixEventSubSubscription

subscribeToUserAuthorizationRevokeEvents(clientId, transport)

async

Subscribe to events that represent a user revoking their authorization from an application.

Parameter	Type	Required	Default	Description
clientId	string		none	The Client ID for the application you want to listen to authorization revoke events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

subscribeToUserUpdateEvents(user, transport)

async

Subscribe to events that represent a user updating their account details.

Parameter	Type	Required	Default	Description
user	UserIdResolvable		none	The user you want to listen to user update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions		none	The transport options.

Return type: HelixEventSubSubscription

Basic usage

Upgrading

Classes

Interfaces

Enums

HelixEventSubApi

Overview

Methods

Before using these methods...

Example

Methods

createSubscription(type, version, condition, transport)

deleteAllSubscriptions()

deleteBrokenSubscriptions()

deleteSubscription(id)

getSubscriptions(pagination)

getSubscriptionsForStatus(status, pagination)

getSubscriptionsForStatusPaginated(status)

getSubscriptionsForType(type, pagination)

getSubscriptionsForTypePaginated(type)

getSubscriptionsPaginated()

subscribeToChannelBanEvents(broadcaster, transport)

subscribeToChannelCheerEvents(broadcaster, transport)

subscribeToChannelFollowEvents(broadcaster, transport)

subscribeToChannelHypeTrainBeginEvents(broadcaster, transport)

subscribeToChannelHypeTrainEndEvents(broadcaster, transport)

subscribeToChannelHypeTrainProgressEvents(broadcaster, transport)

subscribeToChannelModeratorAddEvents(broadcaster, transport)

subscribeToChannelModeratorRemoveEvents(broadcaster, transport)

subscribeToChannelPollBeginEvents(broadcaster, transport)

subscribeToChannelPollEndEvents(broadcaster, transport)

subscribeToChannelPollProgressEvents(broadcaster, transport)

subscribeToChannelPredictionBeginEvents(broadcaster, transport)

subscribeToChannelPredictionEndEvents(broadcaster, transport)

subscribeToChannelPredictionLockEvents(broadcaster, transport)

subscribeToChannelPredictionProgressEvents(broadcaster, transport)

subscribeToChannelRaidEventsFrom(broadcaster, transport)

subscribeToChannelRaidEventsTo(broadcaster, transport)

subscribeToChannelRedemptionAddEvents(broadcaster, transport)

subscribeToChannelRedemptionAddEventsForReward(broadcaster, rewardId, transport)

subscribeToChannelRedemptionUpdateEvents(broadcaster, transport)

subscribeToChannelRedemptionUpdateEventsForReward(broadcaster, rewardId, transport)

subscribeToChannelRewardAddEvents(broadcaster, transport)

subscribeToChannelRewardRemoveEvents(broadcaster, transport)

subscribeToChannelRewardRemoveEventsForReward(broadcaster, rewardId, transport)

subscribeToChannelRewardUpdateEvents(broadcaster, transport)

subscribeToChannelRewardUpdateEventsForReward(broadcaster, rewardId, transport)

subscribeToChannelSubscriptionEndEvents(broadcaster, transport)

subscribeToChannelSubscriptionEvents(broadcaster, transport)

subscribeToChannelSubscriptionGiftEvents(broadcaster, transport)

subscribeToChannelSubscriptionMessageEvents(broadcaster, transport)

subscribeToChannelUnbanEvents(broadcaster, transport)

subscribeToChannelUpdateEvents(broadcaster, transport)

subscribeToExtensionBitsTransactionCreateEvents(clientId, transport)

subscribeToStreamOfflineEvents(broadcaster, transport)

subscribeToStreamOnlineEvents(broadcaster, transport)

subscribeToUserAuthorizationRevokeEvents(clientId, transport)

subscribeToUserUpdateEvents(user, transport)