OptionalauthRequires token authentication by default. Set to unauthenticated to handle
authentication in the handler. Cookie authentication is not supported.
HTTP rate limiting and request logging do not run for unauthenticated
WebSocket routes either; the handler must provide any protections it needs.
Handlers accepting cookies or other ambient credentials should validate the
request origin to prevent cross-site WebSocket hijacking.
An exact path relative to the plugin base URL. Use / for the base URL.
Handles an authenticated upgrade or forwards it upstream. The request retains its full URL. Take ownership of the socket or close it before resolving.
Options for HttpRouterService.addWebSocketHandler.