Add your own analytics

To understand how usage of the Inkeep search or chat affects your business, you may want to log events from the search and chat widgets to your own analytics tool. This could be Mixpanel, Posthog, Amplitude, Segment or other analytics or CDP tools.

We expose the events through a callback function called onEvent that can be configured in the baseSettings configuration.

Below is an example of how to use onEvent to log all events to your analytics tool.

Example

import { type InkeepCallbackEvent } from "@inkeep/agents-ui-cloud";

const baseSettings = {
  onEvent: async (event: InkeepCallbackEvent) => {
    // console.log('event', event);
    // log the event to your own analytics tool for example PostHog
    posthog.capture(event.eventName, {
      ...event.properties,
    });
  }
};