ChatBotKit Node SDK
    Preparing search index...

    Class EventClient

    Event client for accessing event-related functionality.

    This client provides access to ChatBotKit's event system, including event logs that record all significant platform activities. Use the log sub-client to list, export, or subscribe to events.

    const client = new EventClient({ secret: 'your-secret' })

    // List recent events
    const events = await client.log.list({ take: 100 })

    // Export events for a specific conversation
    const exported = await client.log.export({ conversationId: 'conv_123' })

    // Subscribe to live events (Pro+ only)
    const stream = client.log.subscribe()
    for await (const event of stream) {
      console.log('Live event:', event.data.type)
    }

    Hierarchy (View Summary)

    Index
    constructor
    log
    clientProxy extend
    log: EventLogClient

    • Proxies a request and resolves the upstream Response. Successful and upstream-error responses pass through untouched - streaming, binary and large bodies are preserved (the body is never read on the success path). The one exception is a CBK authorization_required signal, which is thrown as an AuthorizationRequiredError carrying the url the user must visit to authenticate.

      Parameters

      • path: string
      • Optionaloptions: {
            buffer?: ArrayBuffer;
            endpoint?: string;
            external?: boolean;
            fetchFn?: FetchFunction;
            file?: { data: string | ArrayBuffer; name?: string; type?: string };
            headers?: Record<string, any>;
            method?: string;
            query?: Record<string, any>;
            record?: Record<string, any>;
            retries?: number;
            retryDelay?: number;
            retryTimeout?: boolean;
            timeout?: number;
        }

      Returns Promise<Response>

    • Creates a new instance of the same client type with extended options.

      This is useful when you need to create a client with modified configuration (e.g., different endpoint, token, or headers) without affecting the original.

      Note: This method creates a completely new instance rather than cloning, which is necessary because private class fields cannot be copied.

      Parameters

      Returns EventClient

      A new instance of the same client class with extended options

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods