Skip to content

WebhookConnectionOptions

1
type WebhookConnectionOptions: BaseConnectionOptions<WebhookConnection> & object;

The options for bulding up a Webhook Connection.

Type declaration

MemberTypeDescription
appTokenTokenAdapter<"app", boolean>The app token used by this connection.
baseURLstringThe base URL for the webhook callback.
dropSubsAtStartboolean

Whether to drop subscriptions at start. This will delete all subscriptions that are currently active within the client (only webhook created) to avoid duplicated subscriptions if any storage was set.

Default

false
secretstringThe secret used for creating subscriptions within this connection.
startServerboolean

Whether to start the server when the connection is started.

Default

false
subscriptionRoutestring

The route for receiving Twitch messages.

Default

/subscriptions

Source

twitchfy/packages/eventsub/src/webhook/types/WebhookConnectionOptions.ts:10