@coveo/headless-react
    Preparing search index...

    Interface EngineConfiguration

    The global headless engine configuration options.

    interface EngineConfiguration {
        accessToken: string;
        analytics?: AnalyticsConfiguration;
        environment?: "dev" | "stg" | "hipaa" | "prod";
        name?: string;
        organizationId: string;
        preprocessRequest?: PreprocessRequest;
        renewAccessToken?: () => Promise<string>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    accessToken analytics? environment? name? organizationId preprocessRequest? renewAccessToken?

    Properties

    accessToken: string

    The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.

    analytics?: AnalyticsConfiguration

    Allows configuring options related to analytics.

    environment?: "dev" | "stg" | "hipaa" | "prod"

    The environment in which the organization is hosted.

    The dev and stg environments are only available internally for Coveo employees (e.g., Professional Services).

    Defaults to prod.

    name?: string

    The Engine name (e.g., myEngine). Specifying your Engine name will help in debugging when using an application with multiple Redux stores.

    'coveo-headless'
    organizationId: string

    The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3)

    preprocessRequest?: PreprocessRequest

    Allows for augmenting a Platform request before it is sent.

    Request to be augmented

    The origin of the client, can be "analyticsFetch", "analyticsBeacon" or "searchApiFetch"

    Augmented request

    renewAccessToken?: () => Promise<string>

    A function that fetches a new access token. The function must return a Promise that resolves to a string (the new access token).

    Settings

    Member Visibility

    On This Page

    Properties