twitcheasy-twitch-bottwitch-authtwitch-auth-tmitwitch-chat-clienttwitch-eventsubtwitch-pubsub-clienttwitch-webhooks
Welcome

Classes

ApiClientBadgesApiBitsApiChannelChannelApiChannelFollowChannelPlaceholderChannelSubscriptionChatApiChatBadgeListChatBadgeSetChatBadgeVersionChatEmoteChatEmoteListChattersListCheermoteListConfigErrorCreatedVideoEmoteSetListHelixApiGroupHelixBanHelixBanEventHelixBitsApiHelixBitsLeaderboardHelixBitsLeaderboardEntryHelixChannelHelixChannelApiHelixChannelEditorHelixChannelEmoteHelixChannelPointsApiHelixChannelSearchResultHelixChatApiHelixChatBadgeSetHelixChatBadgeVersionHelixCheermoteListHelixClipHelixClipApiHelixCustomRewardHelixCustomRewardRedemptionHelixEmoteHelixEmoteFromSetHelixEventSubApiHelixEventSubSubscriptionHelixExtensionsApiHelixExtensionTransactionHelixFollowHelixGameHelixGameApiHelixHypeTrainApiHelixHypeTrainContributionHelixHypeTrainEventHelixInstalledExtensionHelixInstalledExtensionListHelixModerationApiHelixModeratorHelixModeratorEventHelixPaginatedRequestHelixPaginatedRequestWithTotalHelixPaginatedScheduleSegmentRequestHelixPollHelixPollApiHelixPollChoiceHelixPredictionHelixPredictionApiHelixPredictionOutcomeHelixPredictorHelixPrivilegedUserHelixScheduleHelixScheduleApiHelixScheduleSegmentHelixSearchApiHelixStreamHelixStreamApiHelixStreamMarkerHelixStreamMarkerWithVideoHelixSubscriptionHelixSubscriptionApiHelixSubscriptionEventHelixTagHelixTagApiHelixTeamHelixTeamApiHelixTeamWithUsersHelixUserHelixUserApiHelixUserBlockHelixUserExtensionHelixUserRelationHelixUserSubscriptionHelixVideoHelixVideoApiHelixWebHooksApiHelixWebHookSubscriptionKrakenApiGroupNoSubscriptionProgramErrorPrivilegedChannelPrivilegedUserSearchApiStreamStreamApiStreamNotLiveErrorSubscriptionTeamTeamApiTeamWithUsersUnsupportedApiUserUserApiUserBlockUserChatInfoUserFollowUserSubscriptionVideoVideoApi

HelixWebHookHubRequest

The properties describing the WebHook to create or remove.

{
The URL to send notifications to.
callbackUrl: string
Whether to subscribe or unsubscribe from notifications.
mode:
HubMode

Whether to subscribe or unsubscribe from notifications.

Aliased type: "subscribe" | "unsubscribe"

The OAuth scope necessary to subscribe to or unsubscribe from the given topic.
scope?: string
The secret to sign the notification payloads with.
secret?: string
What topic URL to subscribe to or unsubscribe from.
topicUrl: string
The number of seconds the subscription is valid for. Defaults to 3600 (1 hour). Can be at most 864000 (10 days).
}

Properties

callbackUrl

Type: string

The URL to send notifications to.

mode

Type:
HubMode

Whether to subscribe or unsubscribe from notifications.

Aliased type: "subscribe" | "unsubscribe"

Whether to subscribe or unsubscribe from notifications.

scope

Type: ?string

The OAuth scope necessary to subscribe to or unsubscribe from the given topic.

secret

Type: ?string

The secret to sign the notification payloads with.

topicUrl

Type: string

What topic URL to subscribe to or unsubscribe from.

validityInSeconds

Type: ?number

The number of seconds the subscription is valid for. Defaults to 3600 (1 hour). Can be at most 864000 (10 days).