Unblu Agent Embedded JS API
    Preparing search index...

    Interface AgentEmbeddedJsApiConfiguration

    interface AgentEmbeddedJsApiConfiguration {
        apiKey?: string;
        entryPath?: string;
        initTimeout?: number;
        locale?: string;
        serverUrl?: string;
    }
    Index

    Properties

    apiKey? entryPath? initTimeout? locale? serverUrl?

    Properties

    apiKey?: string

    The API key to use. This is optional. If not set, no API key is sent when loading the Unblu integration.

    You can retrieve API keys from the Account Configuration interface. This requires the ADMIN user role.

    entryPath?: string

    The public path used with serverUrl to connect to Unblu.

    If not set, '/app' is used.
    initTimeout?: number

    The timeout in milliseconds for the Unblu integration to load.

    30'000 (30 seconds)
    locale?: string

    The locale to use for all Unblu texts.

    If not set, the browser's locale is used.
    serverUrl?: string

    The URL of the Unblu server to connect to.

    If not set, the domain of the current page is used.

    Settings

    Member Visibility

    On This Page

    Properties