docs.callbacks.title

docs.callbacks.intro

docs.callbacks.available

docs.callbacks.callback	docs.callbacks.parameters	docs.callbacks.description
`onReady`	`() => void`	docs.callbacks.onReadyDesc
`onOpen`	`() => void`	docs.callbacks.onOpenDesc
`onClose`	`() => void`	docs.callbacks.onCloseDesc
`onMessageSent`	`(message: ChatMessage) => void`	docs.callbacks.onMessageSentDesc
`onMessageReceived`	`(message: ChatMessage) => void`	docs.callbacks.onMessageReceivedDesc
`onError`	`(error: WidgetError) => void`	docs.callbacks.onErrorDesc
`onUserUpdated`	`(user: UserConfig) => void`	docs.callbacks.onUserUpdatedDesc
`onAnalyticsEvent`	`(event: AnalyticsEvent) => void`	Called for all trackable user interactions (widget open/close, messages, errors, etc.)

docs.callbacks.example

ChaskWidget.init({
  apiKey: 'your-api-key',
  organizationId: 'your-org-id',
  callbacks: {
    // Called when widget is ready
    onReady: () => {
      console.log('Widget is ready!');
    },

    // Called when chat opens
    onOpen: () => {
      console.log('Chat window opened');
      analytics.track('chat_opened');
    },

    // Called when chat closes
    onClose: () => {
      console.log('Chat window closed');
    },

    // Called when user sends a message
    onMessageSent: (message) => {
      console.log('Message sent:', message.content);
    },

    // Called when a message is received
    onMessageReceived: (message) => {
      console.log('New message from:', message.sender);

      if (!document.hasFocus()) {
        new Notification('New message', {
          body: message.content
        });
      }
    },

    // Called on errors
    onError: (error) => {
      console.error('Widget error:', error.message);
      errorTracker.capture(error);
    },

    // Called when user info is updated
    onUserUpdated: (user) => {
      console.log('User updated:', user.name);
    }
  }
});

docs.callbacks.messageObject

docs.callbacks.messageObjectDesc

docs.api.property	docs.configuration.type	docs.callbacks.description
`id`	`string`	Unique message identifier
`content`	`string`	Message text content
`sender`	`'user' \| 'agent' \| 'system'`	Who sent the message
`timestamp`	`Date`	When the message was sent
`status`	`'sending' \| 'sent' \| 'delivered' \| 'read' \| 'failed'`	Message delivery status

docs.callbacks.errorObject

docs.callbacks.errorObjectDesc

docs.api.property	docs.configuration.type	docs.callbacks.description
`code`	`string`	Error code (e.g., 'CONNECTION_ERROR', 'AUTH_ERROR')
`message`	`string`	Human-readable error message
`details`	`object`	Additional error details (optional)

Common Error Codes

Code	docs.callbacks.description
`CONNECTION_ERROR`	Failed to connect to the server
`AUTH_ERROR`	Authentication failed (invalid API key)
`SEND_ERROR`	Failed to send message
`NETWORK_ERROR`	Network connection issue

Analytics Events

The onAnalyticsEvent callback provides a unified way to track all user interactions with the widget. This is useful for integrating with analytics platforms like Google Analytics, Mixpanel, or custom tracking systems.

Analytics Event Object

docs.api.property	docs.configuration.type	docs.callbacks.description
`type`	`AnalyticsEventType`	The type of event that occurred
`timestamp`	`Date`	When the event occurred
`data`	`object`	Additional event-specific data (optional)

Available Event Types

Event Type	docs.callbacks.description	Data
`widget_loaded`	Widget has been initialized and is ready	-
`widget_opened`	Chat window was opened	-
`widget_closed`	Chat window was closed	-
`message_sent`	User sent a message	`{messageId, hasAttachments}`
`message_received`	Message received from agent	`{messageId, sender}`
`attachment_uploaded`	File was uploaded	`{fileType, fileSize}`
`session_started`	New chat session started	`{conversationId}`
`error_occurred`	An error occurred	`{code, message}`

Analytics Integration Example

ChaskWidget.init({
  apiKey: 'your-api-key',
  organizationId: 'your-org-id',
  callbacks: {
    onAnalyticsEvent: (event) => {
      // Google Analytics 4
      gtag('event', event.type, {
        ...event.data,
        timestamp: event.timestamp.toISOString()
      });

      // Mixpanel
      mixpanel.track(event.type, event.data);

      // Custom analytics endpoint
      fetch('/api/analytics', {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify(event)
      });

      // Console logging for debugging
      console.log('[Analytics]', event.type, event.data);
    }
  }
});