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

WebHookListenerReverseProxyConfig

The configuration of a reverse proxy that the listener may be behind.

{
The path prefix your reverse proxy redirects to the listener.
pathPrefix?: string
The port your reverse proxy is available under.
port?: number
Whether your reverse proxy is available using SSL on the given port.
ssl?: boolean
}

Properties

pathPrefix

Type: ?string

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 /hooks/:name to /:name.

port

Type: ?number

The port your reverse proxy is available under.

ssl

Type: ?boolean

Whether your reverse proxy is available using SSL on the given port.