Base

InkeepBaseSettings

This interface is used to configure the base settings for the Inkeep widgets.

Property	Type	Description
apiKey	`string`	Required. The API key for your integration. Example: `process.env.INKEEP_API_KEY`.
integrationId	`string`	Required. The identifier for the integration point. Example: `process.env.INKEEP_INTEGRATION_ID`.
organizationId	`string`	Required. The identifier for your organization. Example: `process.env.INKEEP_ORGANIZATION_ID`.
organizationDisplayName	`string`	Required. The display name for your organization. Example: `"Inkeep"`.
primaryBrandColor	`string`	Required. The primary brand color. The UX will automatically derive a theme from this color. Example: `"#26D6FF"`.
userId	`string`	User ID for analytics. Default's to an auto-generated ID for the page or browser, depending on `optOutAnalyticalCookies` and `optOutAllAnalytics`.
userEmail	`string`	User email for analytics. Default `undefined`.
userName	`string`	User name for analytics and showing initials in the UX. Default: `undefined`.
userCohorts	`string[]`	Array of user cohorts to correlate to your own customer segmentation in analytics. Default: `[]`.
userToken	`string`	Can be used to gate the search and chat service to authenticated users. See here.
userType	`"EXTERNAL"`	`"INTERNAL"`
logEventCallback	`(event: InkeepCallbackEvent) => void`	Callback function for logging events to integrate with your own analytics. Refer to Use your own analytics for details.
optOutAnalyticalCookies	`boolean`	Option to disable cookies used for tracking a user's Inkeep usage behavior across multiple browser sessions. Only same-domain cookies are used. Default: `false`.
optOutAllAnalytics	`boolean`	Option to disable all usage analytics, even anonymous ones. Default: `false`.
optOutFunctionalCookies	`boolean`	Option to disable cookies that are used for functionality. Default: `false`.
remoteErrorLogsLevel	`RemoteErrorLogsLevel`	The level of remote error logging for Inkeep's monitoring service. Default: `RemoteErrorLogsLevel.IdentifiableErrors`.
consoleDebugLevel	`ConsoleDebugLevel`	The level of logging to your console. Default: `ConsoleDebugLevel.Errors`.
chatApiProxyDomain	`string`	Domain for routing search and chat API calls through a proxy. Default: `undefined`. Example: `myproxy.com`.
analyticsApiProxyDomain	`string`	Domain for routing analytics API calls through a proxy. Default: `undefined`. Example: `myproxy.com`.
env	`"DEVELOPMENT"`	`"PRODUCTION"`
tags	`string[]`	Associate questions together by tag for analytics.
appendQueryParamsToUrls	`Record<string, string>`	Optional query parameters to be added to documentation links. Useful for click tracking via UTM tags. Example: `{ utm_source: 'inkeep_widget' }`.
theme	`UserTheme`	Use the theme configuration to configure colors, fonts, z-indexes and other properties of the widget. Learn more.
customIcons	`CustomIcons`	Optional icon overrides. Learn more.
colorMode	`ColorMode`	Control the color mode of the widget. Learn more.
prism	`PrismLib`	Pass in your own instance of the Prismjs library, we recommend doing this if you are using any plugins or doing any custom modifications to the instance of Prism in your application to avoid conflicts with the global Prism namespace. Note that you will need to import any additional languages you wish the syntax highlighter to support.

Example

import { type InkeepBaseSettings } from "@inkeep/uikit";
 
export const baseSettings: InkeepBaseSettings = {
  apiKey: process.env.INKEEP_API_KEY!,
  integrationId: process.env.INKEEP_INTEGRATION_ID!,
  organizationId: process.env.INKEEP_ORGANIZATION_ID!,
  organizationDisplayName: "Inkeep",
  primaryBrandColor: "#26D6FF",
  product: "Inkeep Product",
  productVersion: "1.0.0",
  userId: "user_id",
  userEmail: "user@example.com",
  userName: "John Doe",
  userCohorts: ["cohort1", "cohort2"],
  optOutAnalyticalCookies: false,
  optOutAllAnalytics: false,
  optOutFunctionalCookies: false,
  remoteErrorLogsLevel: RemoteErrorLogsLevel.AnonymousErrors,
  consoleDebugLevel: ConsoleDebugLevel.Errors,
  chatApiProxyDomain: "myproxy.com",
  env: "PRODUCTION",
};

InkeepBaseSettings

Example

On this page