Overview
Methods
- createsa
Methods
create(config)
staticasyncTakes the legacy WebHookListenerConfig and creates a connection adapter from it.
Parameter | Type | Required | Default | Description |
---|---|---|---|---|
config | WebHookListenerConfig | none | see below | |
config.hookValidity | number | none | 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. | |
config.hostName | string | none | The host name the server will be available under. This is not an URL, but a plain host name, so it shouldn't contain If not given, your IPv4 address will be automatically determined using a web service. | |
config.logger | Partial<LoggerOptions> | none | Options to pass to the logger. | |
config.port | number | none | The port the server should listen to, and unless If not given, a free port will be automatically determined. | |
config.reverseProxy | WebHookListenerReverseProxyConfig | none | Configuration of a reverse proxy that the listener may be behind. | |
config.reverseProxy.pathPrefix | string | none | The path prefix your reverse proxy redirects to the listener. Please keep in mind that this prefix needs to be stripped from the URL in order for the listener to work properly. For example, if you make your reverse proxy redirect any requests to https://twitchapp.example.com/hooks to the listener, the proxy needs to transform the URL from | |
config.reverseProxy.port | number | none | The port your reverse proxy is available under. | |
config.reverseProxy.ssl | boolean | none | Whether your reverse proxy is available using SSL on the given port. | |
config.ssl | WebHookListenerCertificateConfig | none | The SSL keychain that should be used to make the server available using a secure connection. If this is not given and | |
config.ssl.cert | string | none | Your full SSL certificate chain, including all intermediate certificates. | |
config.ssl.key | string | none | The private key of your SSL certificate. |