Interface WebChatAuthParams

Platform-specific parameters for WebChat connections.

interface WebChatAuthParams {
    apiKey?: string;
    corsOrigins?: string;
    port?: string;
    wsPath?: string;
}

Hierarchy

  • Record<string, string | undefined>
    • WebChatAuthParams

Properties

apiKey? corsOrigins? port? wsPath?

Properties

Optional apiKey

apiKey?: string

API key for authenticating WebSocket clients. Optional.

Optional corsOrigins

corsOrigins?: string

Comma-separated CORS origins (default: '*').

Optional port

port?: string

Port for standalone HTTP server (default: '8080'). Ignored in attached mode.

Optional wsPath

wsPath?: string

Path prefix for the WebSocket endpoint (default: '/ws').

Settings

Member Visibility

Theme

On This Page

apiKeycorsOriginsportwsPath