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

Basic usage

Getting startedListening to events

Special hosting

Serving through a reverse proxyTesting locally using ngrok

Classes

ConnectionAdapterEnvPortAdapterLegacyAdapterReverseProxyAdapterSimpleAdapterSubscriptionWebHookListener

Interfaces

ConnectCompatibleAppConnectionAdapterOverrideOptionsEnvPortAdapterConfigReverseProxyAdapterConfigSimpleAdapterConfigWebHookConfigWebHookListenerCertificateConfigWebHookListenerConfigWebHookListenerReverseProxyConfig

WebHookListenerConfig

Legacy configuration of a WebHook listener.

{
Default validity of a WebHook, in seconds.
hookValidity?: number
The host name the server will be available under.
hostName?: string
Options to pass to the logger.
logger?: Partial<LoggerOptions>
The port the server should listen to, and unless `reverseProxy` configuration is given, also the port it's available under.
port?: number
Configuration of a reverse proxy that the listener may be behind.
The SSL keychain that should be used to make the server available using a secure connection.
}

Properties

hookValidity

Type: ?number

Default validity of a WebHook, in seconds.

Please note that this doesn't mean that you don't get any notifications after the given time. The hook will be automatically refreshed.

This is meant for debugging issues. Please don't set it unless you know what you're doing.

hostName

Type: ?string

The host name the server will be available under.

This is not an URL, but a plain host name, so it shouldn't contain http:// or https:// or any slashes.

If not given, your IPv4 address will be automatically determined using a web service.

logger

Type: ?Partial<LoggerOptions>

Options to pass to the logger.

port

Type: ?number

The port the server should listen to, and unless reverseProxy configuration is given, also the port it's available under.

If not given, a free port will be automatically determined.

reverseProxy

Type: ?WebHookListenerReverseProxyConfig

Configuration of a reverse proxy that the listener may be behind.

ssl

Type: ?WebHookListenerCertificateConfig

The SSL keychain that should be used to make the server available using a secure connection.

If this is not given and config.reverseProxy.ssl is not true, the server will only be available via HTTP. This means it can only listen to unauthenticated topics (stream changes and follows).