Skip to content
ChatKit

CustomApiConfig

type CustomApiConfig = {
  domainKey: string;
  fetch?: typeof fetch;
  uploadStrategy?: FileUploadStrategy;
  url: string;
};

Properties

Section titled “Properties”

domainKey

Section titled “domainKey”
domainKey: string;

The domain key that will be used to verify the registered domain for the integration.

fetch?

Section titled “fetch?”
optional fetch: typeof fetch;

Custom fetch function to use for API requests. This is useful for overriding the default fetch behavior, such as adding custom headers or setting credentials.

uploadStrategy?

Section titled “uploadStrategy?”
optional uploadStrategy: FileUploadStrategy;

How attachments will be uploaded to your server. Required when attachments are enabled.

url

Section titled “url”
url: string;

The URL (relative or absolute) of the ChatKit API. The configured endpoint must conform to the specification defined in the ChatKit SDK documentation. The easiest way to get started is by using the ChatKit SDK which will help you define your integration in a declarative way.