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	Description
type	string	The type of the event.
version	string	The version of the event.
condition	Record<string, unknown>	The condition of the subscription.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
id	string	The ID of the subscription.

Return type: void

getSubscriptions()

async

Retrieves the current WebHook subscriptions for the current client.

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

Return type: HelixPaginatedResultWithTotal<HelixEventSubSubscription>

getSubscriptionsPaginated()

Retrieves 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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to ban events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport option.

Return type: HelixEventSubSubscription

subscribeToChannelCheerEvents(broadcaster, transport)

async

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

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

Return type: HelixEventSubSubscription

subscribeToChannelFollowEvents(broadcaster, transport)

async

Subscribe to events that represent a user following a channel.

Parameter	Type	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to follow events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to Hype train begin events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelHypeTrainEndEvents(broadcaster, transport)

async

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

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

Return type: HelixEventSubSubscription

subscribeToChannelHypeTrainProgressEvents(broadcaster, transport)

async

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

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

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionAddEvents(broadcaster, transport)

async

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

Parameter	Type	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to redemption events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to redemption events for.
rewardId	string	The ID of the reward you want to listen to redemption events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelRedemptionUpdateEvents(broadcaster, transport)

async

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

Parameter	Type	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to redemption update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to redemption update events for.
rewardId	string	The ID of the reward you want to listen to redemption updates for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to reward add events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to reward remove events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to reward remove events for.
rewardId	string	The ID of the reward you want to listen to remove events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport events.

Return type: HelixEventSubSubscription

subscribeToChannelRewardUpdateEvents(broadcaster, transport)

async

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

Parameter	Type	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to reward update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to reward update events for.
rewardId	string	The ID of the reward you want to listen to update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport options.

Return type: HelixEventSubSubscription

subscribeToChannelSubscriptionEvents(broadcaster, transport)

async

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

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

Return type: HelixEventSubSubscription

subscribeToChannelUnbanEvents(broadcaster, transport)

async

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

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

Return type: HelixEventSubSubscription

subscribeToChannelUpdateEvents(broadcaster, transport)

async

Subscribe to events that represent a channel updating their metadata.

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

Return type: HelixEventSubSubscription

subscribeToStreamOfflineEvents(broadcaster, transport)

async

Subscribe to events that represent a stream going offline.

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

Return type: HelixEventSubSubscription

subscribeToStreamOnlineEvents(broadcaster, transport)

async

Subscribe to events that represent a stream going live.

Parameter	Type	Description
broadcaster	UserIdResolvable	The broadcaster you want to listen to online events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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	Description
clientId	string	The Client ID for the application you want to listen to authorization revoke events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	The transport options.

Return type: HelixEventSubSubscription

subscribeToUserUpdateEvents(user, transport)

async

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

Parameter	Type	Description
user	UserIdResolvable	The user you want to listen to user update events for.
transport	HelixEventSubTransportOptions Aliased type: HelixEventSubWebHookTransportOptions	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()

getSubscriptionsPaginated()

subscribeToChannelBanEvents(broadcaster, transport)

subscribeToChannelCheerEvents(broadcaster, transport)

subscribeToChannelFollowEvents(broadcaster, transport)

subscribeToChannelHypeTrainBeginEvents(broadcaster, transport)

subscribeToChannelHypeTrainEndEvents(broadcaster, transport)

subscribeToChannelHypeTrainProgressEvents(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)

subscribeToChannelSubscriptionEvents(broadcaster, transport)

subscribeToChannelUnbanEvents(broadcaster, transport)

subscribeToChannelUpdateEvents(broadcaster, transport)

subscribeToStreamOfflineEvents(broadcaster, transport)

subscribeToStreamOnlineEvents(broadcaster, transport)

subscribeToUserAuthorizationRevokeEvents(clientId, transport)

subscribeToUserUpdateEvents(user, transport)