ChatBotKit Node SDK
    Preparing search index...

    Class EventLogClient

    Event log client for accessing event logs.

    This client provides access to ChatBotKit's event logging system, which records all significant events that occur in your account. Events include conversation creation, message exchanges, bot interactions, and other platform activities. Use this client to retrieve historical events, export event data, or subscribe to live event streams for real-time monitoring.

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

    // Filter events by conversation
    const conversationEvents = await client.event.log.list({
      conversationId: 'conv_123',
      take: 50
    })

    // Subscribe to live events (requires Pro+ plan)
    const stream = client.event.log.subscribe({ historyLength: 10 })
    for await (const event of stream) {
      console.log('Event:', event.data.type, event.data.id)
    }

    Hierarchy (View Summary)

    Index
    constructor
    clientProxy export extend list subscribe

    • 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 EventLogClient

      A new instance of the same client class with extended options

    • Subscribes to live event logs.

      This method establishes a streaming connection to receive real-time events as they occur. The connection remains open until closed by the client. This feature requires a Pro plan or higher.

      Parameters

      • Optionalrequest: {}

      Returns ResponsePromise<never, {}>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods