ChatBotKit Node SDK
    Preparing search index...

    Interface ChatBotKitClientOptions

    interface ChatBotKitClientOptions {
        baseUrl?: string | URL;
        endpoints?: Record<string, string>;
        fetchFn?: FetchFunction;
        headers?: Record<string, string>;
        host?: string;
        protocol?: "http:" | "https:";
        retries?: number;
        retryDelay?: number;
        retryTimeout?: boolean;
        runAsChildUserEmail?: string;
        runAsUserId?: string;
        secret: string;
        timeout?: number;
        timezone?: string;
    }
    Index

    Properties

    baseUrl? endpoints? fetchFn? headers? host? protocol? retries? retryDelay? retryTimeout? runAsChildUserEmail? runAsUserId? secret timeout? timezone?

    Properties

    baseUrl?: string | URL

    An optional base URL to use for the API

    endpoints?: Record<string, string>

    An optional map of endpoints to override

    fetchFn?: FetchFunction

    An optional fetch implementation function to use instead

    headers?: Record<string, string>

    An optional map of headers to add to the request

    host?: string

    An optional hostname to use for the API

    protocol?: "http:" | "https:"

    An optional protocol to use for the API

    retries?: number

    An optional number of retries for the request

    retryDelay?: number

    An optional delay in milliseconds between retries

    retryTimeout?: boolean

    An optional flag to retry on timeout errors

    runAsChildUserEmail?: string

    An optional child user email to run as (experimental)

    runAsUserId?: string

    An optional user ID to run as

    secret: string

    A token to authenticate with the API

    timeout?: number

    An optional timeout in milliseconds for the request

    timezone?: string

    An optional timezone to use for the API

    Settings

    Member Visibility

    On This Page

    Properties