Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Configuration

Hierarchy

  • Configuration

Index

Properties

apiKey

apiKey: string

An API-Key of the account to be used. This is a mandatory configuration.

API keys can be retrieved from the Unblu Agent Desk in the settings section. Keep in mind, that an Admin role is needed.

Optional entryPath

entryPath: string

The public path to Unblu which will be used in combination with serverUrl to connect to Unblu.

default

If not set, '/unblu' will be used.

Optional initTimeout

initTimeout: number

The timeout im milliseconds that should be waited for the Unblu integration to load.

default

30'000 (30 seconds).

Optional locale

locale: string

The locale to be used for all Unblu translation texts.

default

If not set, the browsers locale will be used.

Optional namedArea

namedArea: string

The named area to be used. The named area determines the agent availability, the queue that conversation requests go to, and the configuration.

default

If not set, if the <meta name="unblu:named-area" content="<your-named-area>"/> will be used if present and if not, the domain will be used.

Optional serverUrl

serverUrl: string

The url of the Unblu server to connect to.

default

If not set, the domain of the current page will be used.