TwurpleAuthenticationGetting dataExamplesFAQMigration

EventSubHttpListenerConfig

Configuration for an EventSub HTTP listener.

{
The connection adapter responsible for the configuration of the connection method.
The API client that will be used to subscribe to events.
Whether to add additional helper routes such as the test route at the root.
helperRoutes?: boolean
Options to pass to the logger.
logger?: Partial<LoggerOptions>
Your EventSub secret.
secret: string
Whether to ignore packets that are not sent with a Host header matching the configured host name.
strictHostCheck?: boolean
}

Properties

adapter

Type: ConnectionAdapter

The connection adapter responsible for the configuration of the connection method.

apiClient

Type: ApiClient

The API client that will be used to subscribe to events.

helperRoutes

Type: ?boolean

Whether to add additional helper routes such as the test route at the root.

Enabled by default. Set this to false to disable it.

logger

Type: ?Partial<LoggerOptions>

Options to pass to the logger.

secret

Type: string

Your EventSub secret.

This should be a randomly generated string, but it should be the same between restarts.

WARNING: Please do not use your application's client secret!

strictHostCheck

Type: ?boolean

Whether to ignore packets that are not sent with a Host header matching the configured host name.

Enabled by default. Set this to false to disable it.