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

SimpleAdapter

A simple WebHook connection adapter. Requires the server to be directly available to the internet.

Constructor

new SimpleAdapter(options)

Creates a new simple WebHook adapter.

Parameter Type Required Default Description
options SimpleAdapterConfig none
options.hostName string none

The host name the server is available under.

options.listenerPort number none

The port the server should listen to.

options.sslCert WebHookListenerCertificateConfig none

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

If this is not given and there is no reverse proxy that handles incoming SSL connections, the server will only be available via HTTP. This means it can only listen to unauthenticated topics (stream changes and follows).

options.sslCert.cert string none

Your SSL certificate.

options.sslCert.key string none

The private key of your SSL certificate.