Contact usRequest a demo

Configuration Properties

Preview

Configuration properties labelled "Preview":

  • Are new features for you to try out

  • May change or be removed without further notice in a future version

  • Shouldn’t be used in production

More about Preview

Deprecated

Configuration properties labelled "Deprecated":

  • Will be removed in the next major version of Unblu

  • Typically don’t affect the product anymore

More about Deprecated

User synchronization (LDAP) tool

Abort sync job if no users returned

com.unblu.addons.server.synctool.SyncTool.abortSyncOnNoUsersReturned

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If true and the source system returns no users, the syncjob is aborted

Unblu account ID

com.unblu.addons.server.synctool.SyncTool.accountId

  • Type: String

  • Default: wZvcAnbBSpOps9oteH-Oxw

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The default is UnbluEntityDefaults.DEFAULT_ACCOUNT_ID

Run sync tool in multitenancy mode

com.unblu.addons.server.synctool.SyncTool.multitenancySyncMode

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Overwrite existing target users

com.unblu.addons.server.synctool.SyncTool.overwriteExistingTargetUsers

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If true, the sync job overwrites users in the target system if it finds a user with the same username but different metadata. If false, the syncjob skip susers in the target system with the same username but different metadata, leaving them unchanged.

Delete synced users and teams

com.unblu.addons.server.synctool.SyncTool.propagateDeletes

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If true, users and teams no longer present in the LDAP source are deleted from the Unblu database

runAtCronExpressions

com.unblu.addons.synctool.runAtCronExpressions

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

If set, array of cron-like expression such as [* */15 * ? * * syncall','5 * * ? * * * syncuser',…​] to run syncronization periodically. Refer to http://www.quartz-scheduler.org/documentation/quartz-2.3.0/tutorials/crontrigger.html for further information. Additionally it supports the @reboot cron command for example '@reboot syncall'. If you sync both teams and users, you must use syncall instead of separate syncuser and syncteam.

EntitySourceLDAP

adminRoleIdentifier

com.unblu.addons.synctool.ldap.adminRoleIdentifier

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Identifier for an Unblu Role, either as a property on user or for %role% in the roleFilter

baseDN

com.unblu.addons.synctool.ldap.baseDN

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

base dn for all filters retrieval

connectionSecurity

com.unblu.addons.synctool.ldap.connectionSecurity

  • Type: String with allowed values:

    • ldaps

    • none

    • starttls

  • Default: NONE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Connection security to use: one of 'NONE' for no encryption,'LDAPS' for SSL/TLS support or 'STARTTLS' for Start TLS

defaultRole

com.unblu.addons.synctool.ldap.defaultRole

  • Type: String with allowed values:

    • admin

    • anonymous_user

    • partner

    • registered_user

    • supervisor

    • super_admin

    • technical_admin

    • webuser

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Default role for unblu users that aren’t assigned a role explicitly. If not set users without a role will be ignored and not synced.

pathToTrustedCertsKeyStoreFile

com.unblu.addons.synctool.ldap.pathToTrustedCertsKeyStoreFile

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If an encrypted LDAP connection is used, this path is used to load a key store file, which contains the trusted certificates

registeredUserRoleIdentifier

com.unblu.addons.synctool.ldap.registeredUserRoleIdentifier

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Identifier for an Unblu Role, either as a property on user or for %role% in the roleFilter

roleFilter

com.unblu.addons.synctool.ldap.roleFilter

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP filter to retrieve all unblu roles (if they are a groupOfNames), must contain %role% as wildcard for all roleIdentifiers

roleFilterBaseDN

com.unblu.addons.synctool.ldap.roleFilterBaseDN

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

base dn for role retrieval. Uses non-user/non-team baseDN as default

roleMemberAttributeName

com.unblu.addons.synctool.ldap.roleMemberAttributeName

  • Type: String

  • Default: member

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The member attribute name for member listing in role groupOfNames.

roleSearchScope

com.unblu.addons.synctool.ldap.roleSearchScope

  • Type: String with allowed values:

    • object

    • onelevel

    • subtree

  • Default: SUBTREE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP Search scope for the roleFilter based query. Possible values are OBJECT,ONELEVEL and SUBTREE

serverHostname

com.unblu.addons.synctool.ldap.serverHostname

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The ldap server hostname or ip

serverPassword

com.unblu.addons.synctool.ldap.serverPassword

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The authentication password for the serverUsername-user

serverPort

com.unblu.addons.synctool.ldap.serverPort

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The ldap server port. If not specified (null), the default LDAP port (389 without ecryption or 636 for LDAPS) is used

serverUsername

com.unblu.addons.synctool.ldap.serverUsername

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Server Username (usually similar to cn=Admin or cn=Directory Manager,…​

superadminRoleIdentifier

com.unblu.addons.synctool.ldap.superadminRoleIdentifier

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Identifier for an Unblu Role, either as a property on user or for %role% in the roleFilter

supervisorRoleIdentifier

com.unblu.addons.synctool.ldap.supervisorRoleIdentifier

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Identifier for an Unblu Role, either as a property on user or for %role% in the roleFilter

teamFilter

com.unblu.addons.synctool.ldap.teamFilter

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP filter to retrieve all unblu teams, may contain %team% or %role%

teamFilterBaseDN

com.unblu.addons.synctool.ldap.teamFilterBaseDN

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

base dn for team retrieval. Uses non-user/non-team baseDN as default

teamIdAttributeName

com.unblu.addons.synctool.ldap.teamIdAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The team id attribute name

teamMatchOrderPrecedence

com.unblu.addons.synctool.ldap.teamMatchOrderPrecedence

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A list of regular expressions in a specific order. If a user is assigned to multiple teams in the LDAP system, this list specifies the order in which his team is chosen. The list of teams from LDAP is matched against this list. Entries appearing earlier in the list will have precedence over entries appearing later or not at all.

teamMemberAttributeName

com.unblu.addons.synctool.ldap.teamMemberAttributeName

  • Type: String

  • Default: member

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The member attribute name for member listing in team groupOfNames.

teamSearchScope

com.unblu.addons.synctool.ldap.teamSearchScope

  • Type: String with allowed values:

    • object

    • onelevel

    • subtree

  • Default: SUBTREE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP Search scope for the teamFilter based query. Possible values are OBJECT,ONELEVEL and SUBTREE

technicaladminRoleIdentifier

com.unblu.addons.synctool.ldap.technicaladminRoleIdentifier

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Identifier for an Unblu Role, either as a property on user or for %role% in the roleFilter

timeoutMS

com.unblu.addons.synctool.ldap.timeoutMS

  • Type: Integer

  • Default: 30000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The timeout in milliseconds for ldap connections

trustManagerAlgorithm

com.unblu.addons.synctool.ldap.trustManagerAlgorithm

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Defines the algorithm which is used to read/use the trusted certifactes from the keystore file. If not specified, the default which is defined in the jvm property 'ssl.TrustManagerFactory.algorithm' is used. Normaly this is 'PKIX'. Other known type is 'SunX509'

trustedCertsKeyStorePassword

com.unblu.addons.synctool.ldap.trustedCertsKeyStorePassword

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If an encrypted LDAP connection is used, this password is used to load a key store file, which contains the trusted certificates

trustedCertsKeyStoreType

com.unblu.addons.synctool.ldap.trustedCertsKeyStoreType

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Defines the type of the keystore file, which contains the trusted certificates. If not specified, the default which is stored in the jvm security.property file at 'keystore.type' is used. Normaly this is 'JKS'. All known types: 'JCEKS', 'JKS', 'DKS', 'PKCS11', 'PKCS12'

userEmailAttributeName

com.unblu.addons.synctool.ldap.userEmailAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The attribute name of the user entry/object that stores the email address of the user (optional)

userFilter

com.unblu.addons.synctool.ldap.userFilter

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP filter to retrieve all unblu users, may contain %team%

userFilterBaseDN

com.unblu.addons.synctool.ldap.userFilterBaseDN

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

base dn for user retrieval. Uses non-user/non-team baseDN as default

userFirstNameAttributeName

com.unblu.addons.synctool.ldap.userFirstNameAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The attribute name of the user entry/object that stores the first name of the user (optional)

userIdAttributeName

com.unblu.addons.synctool.ldap.userIdAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The user id attribute name

userLastNameAttributeName

com.unblu.addons.synctool.ldap.userLastNameAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The attribute name of the user entry/object that stores the last name of the user (optional)

userNameAttributeName

com.unblu.addons.synctool.ldap.userNameAttributeName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The user name attribute name

userSearchScope

com.unblu.addons.synctool.ldap.userSearchScope

  • Type: String with allowed values:

    • object

    • onelevel

    • subtree

  • Default: SUBTREE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LDAP Search scope for the userFilter based query. Possible values are OBJECT,ONELEVEL and SUBTREE

Authenticator configuration

Authentication token TTL

com.unblu.authenticator.authenticationTokenTTLInSeconds

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time to live (TTL), in seconds, for authentication tokens

Reject user logins

com.unblu.authenticator.rejectUserLogins

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether normal user logins should be rejected or not if a password file for the superadmin exists.

Canned responses list configuration

Number of days to count canned response usages

com.unblu.agent.cannedresponses.list.ui.pastDaysToCountUsageFor

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

    • Maximum value: 180

The resulting usages are displayed in the canned response management UIs. Maximum is 180 days.

CannedResponsesRoleGuard

cannedResponsesMinimalRole

com.unblu.core.settings.cannedResponsesMinimalRole

  • Type: String with allowed values:

    • admin

    • anonymous_user

    • partner

    • registered_user

    • supervisor

    • super_admin

    • technical_admin

    • webuser

  • Default: REGISTERED_USER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Minimal role for settings cannedResponses module

Deputy relationships role guard

Minimum role for changes in "deputyRelationships"

com.unblu.core.settings.deputyRelationshipsMinimalRole

  • Type: String with allowed values:

    • admin

    • anonymous_user

    • partner

    • registered_user

    • supervisor

    • super_admin

    • technical_admin

    • webuser

  • Default: REGISTERED_USER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The minimum role for changing settings in the "deputyRelationships" module

Account and Global Server Configuration interface sidebar style

Color of active navigation entry

com.unblu.config.nav.ui.activeHighlight

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of hovered navigation entry

com.unblu.config.nav.ui.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral100\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of hovered active navigation entry

com.unblu.config.nav.ui.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral100\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of navigation entry

com.unblu.config.nav.ui.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of active navigation entry

com.unblu.config.nav.ui.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of pressed navigation entry

com.unblu.config.nav.ui.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral200\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color of pressed active navigation entry

com.unblu.config.nav.ui.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral200\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of hovered navigation entry

com.unblu.config.nav.ui.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of hovered active navigation entry

com.unblu.config.nav.ui.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of navigation entry

com.unblu.config.nav.ui.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of active navigation entry

com.unblu.config.nav.ui.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of pressed navigation entry

com.unblu.config.nav.ui.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border color of pressed active navigation entry

com.unblu.config.nav.ui.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border radius of navigation entry

com.unblu.config.nav.ui.borderRadius

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Border width of navigation entry

com.unblu.config.nav.ui.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of hovered navigation entry

com.unblu.config.nav.ui.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of hovered active navigation entry

com.unblu.config.nav.ui.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of navigation entry

com.unblu.config.nav.ui.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of active navigation entry

com.unblu.config.nav.ui.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of pressed navigation entry

com.unblu.config.nav.ui.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Foreground color of pressed active navigation entry

com.unblu.config.nav.ui.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Background color

com.unblu.config.nav.ui.navBarBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral050\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Section header font color

com.unblu.config.nav.ui.sectionHeaderColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Section header font size

com.unblu.config.nav.ui.sectionHeaderSize

  • Type: String with allowed values:

    • heading1

    • heading2

    • heading3

    • paragraph

    • small

    • tiny

  • Default: TINY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Section header font weight

com.unblu.config.nav.ui.sectionHeaderWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: SEMIBOLD

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the sidebar of the Account and Global Server Configuration interfaces

Conversation recording configuration

Action bar background color

com.unblu.recording.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.recording.ui.actionBarDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.recording.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.recording.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Collaboration space background color

com.unblu.recording.ui.collaborationSpaceBackgroundColor

  • Type: Complex color

  • Default: #525659

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Background color of the collaboration space for recordings

Right column width

com.unblu.recording.ui.rightColumnWidth

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width, in pixels, of the right-hand column for recordings. The right-hand column contains the chat and the call if multiple sources are active.

Agent action bar configuration

Action bar background color

com.unblu.agent.ui.actionbar.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.agent.ui.actionbar.actionBarDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.agent.ui.actionbar.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: FLAT

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.agent.ui.actionbar.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Agent conversation shortcut configuration

Shortcut for toggling "mark mode" layer action

com.unblu.agent.conversation.shortcuts.layerActionMarkShortcut

  • Type: Keyboard shortcut

  • Default: $mod+shift+a

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for toggling mark mode in the collaboration layer. Make sure it is not already used by the browser itself.

Collaboration layer remote control toggle shortcut

com.unblu.agent.conversation.shortcuts.layerActionRemoteControlShortcut

  • Type: Keyboard shortcut

  • Default: $mod+shift+s

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for toggling the collaboration layer remote control. Make sure it is not already used by the browser itself.

Scroll lock layer action shortcut

com.unblu.agent.conversation.shortcuts.layerActionScrollLockShortcut

  • Type: Keyboard shortcut

  • Default: $mod+shift+l

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for toggling the scroll lock in the collaboration layer. Make sure it is not already used by the browser itself.

Shortcut for opening canned responses selection dialog

com.unblu.agent.conversation.shortcuts.openCannedResponsesShortcut

  • Type: Keyboard shortcut

  • Default: $mod+y

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for opening the canned responses selection dialog. Make sure it is not already used by the browser itself.

Shortcut for toggling chat panel

com.unblu.agent.conversation.shortcuts.toggleIndividualUiShortcut

  • Type: Keyboard shortcut

  • Default: $mod+shift+i

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for toggling the chat panel in a conversation. Make sure it is not already used by the browser itself.

Shortcut to maximize/minimize the collaboration space

com.unblu.agent.conversation.shortcuts.toggleMaximizeCollabSpaceShortcut

  • Type: Keyboard shortcut

  • Default: $mod+shift+f

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut for maximizing and minimizing the collaboration space. Make sure it is not already used by the browser itself.

Agent conversation UI

Show agent capacity for invitations

com.unblu.agent.conversation.ui.agentInviteShowCapacity

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show an agent’s availability to accept conversation requests when inviting them to a conversation or forwarding them a conversation. The information is only conclusive for agents who have an inbound queue for visitor-initiated conversations, and whose inbound queue is managed by Unblu rather than a third-party system.

Background color of collaboration layer header bars

com.unblu.agent.conversation.ui.collaborationLayerHeaderBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral050\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the collaboration space

com.unblu.agent.conversation.ui.collaborationSpaceBackgroundColor

  • Type: Complex color

  • Default: #525659

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Chat panel default width

com.unblu.agent.conversation.ui.unbluUiDefaultWidth

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Collaboration layer maximize button style

"Hovered" background color

com.unblu.conversation.collabspace.layer.header.maximize.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "hovered" state

"Hovered" background color (active)

com.unblu.conversation.collabspace.layer.header.maximize.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "hovered (active)" state

Normal background color

com.unblu.conversation.collabspace.layer.header.maximize.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "normal" state

Normal background color (active)

com.unblu.conversation.collabspace.layer.header.maximize.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "normal (active)" state

"Pressed" background color

com.unblu.conversation.collabspace.layer.header.maximize.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "pressed" state

"Pressed" background color (active)

com.unblu.conversation.collabspace.layer.header.maximize.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer maximize" button in "pressed (active)" state

"Hovered" border color

com.unblu.conversation.collabspace.layer.header.maximize.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "hovered" state

"Hovered" border color (active)

com.unblu.conversation.collabspace.layer.header.maximize.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "hovered (active)" state

Normal border color

com.unblu.conversation.collabspace.layer.header.maximize.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "normal" state

Normal border color (active)

com.unblu.conversation.collabspace.layer.header.maximize.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "normal (active)" state

"Pressed" border color

com.unblu.conversation.collabspace.layer.header.maximize.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "pressed" state

"Pressed" border color (active)

com.unblu.conversation.collabspace.layer.header.maximize.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer maximize" button in "pressed (active)" state

Border width

com.unblu.conversation.collabspace.layer.header.maximize.borderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "collaboration layer maximize" button

"Hovered" foreground color

com.unblu.conversation.collabspace.layer.header.maximize.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.conversation.collabspace.layer.header.maximize.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "hovered (active)" state

Normal foreground color

com.unblu.conversation.collabspace.layer.header.maximize.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "normal" state

Normal foreground color (active)

com.unblu.conversation.collabspace.layer.header.maximize.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "normal (active)" state

"Pressed" foreground color

com.unblu.conversation.collabspace.layer.header.maximize.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.conversation.collabspace.layer.header.maximize.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer maximize" button in "pressed (active)" state

Base "edit conversation" component configuration

Allow creating scheduled conversations in the past

com.unblu.conversation.editflyin.allowCreatingConversationsInThePast

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify if the UI allows the scheduled conversation time to be in the past when creating or editing

Inbox shortcut configuration

Shortcut to open "Forwarded" tab

com.unblu.agent.inbox.shortcuts.openInboxForwardedShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+f

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the 'Forwarded' inbox tab. Make sure it isn’t already used by the browser itself and works on your keyboard layout.

Shortcut to open primary inbox tab

com.unblu.agent.inbox.shortcuts.openInboxPrimaryShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+p

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the primary inbox tab. Make sure it isn’t already used by the browser itself and works on your keyboard layout.

Shortcut to open secondary inbox tab

com.unblu.agent.inbox.shortcuts.openInboxSecondaryShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+s

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the secondary inbox tab. Make sure it isn’t already used by the browser itself and works on your keyboard layout.

Inbox UI configuration

Default inbox sort order

com.unblu.agent.inbox.ui.defaultSortOrder

  • Type: String with allowed values:

    • asc

    • desc

  • Default: DESC

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Conversations are sorted by timestamp of the last message

Display forwarded conversations in separate tab

com.unblu.agent.inbox.ui.displayForwardedConversationsInTabs

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

If enabled, conversations forwarded by an agent are displayed in a separate tab in the agent’s inbox

Display two tabs in agent inbox

com.unblu.agent.inbox.ui.displayOwnAndSecondaryConversationsInTabs

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

If enabled, the agent inbox is split into two tabs, one for conversations where the agent is the primary agent and one for conversations where they are the secondary agent

Conversation UI

Options of "request awaited person type" dialog

com.unblu.agent.conversation.ui.changeAwaitedPersonTypeDialogOptions

  • Type: List of string with allowed values:s

    • agent

    • none

    • visitor

  • Default: NONE,VISITOR,AGENT

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

"Join conversation" timeout (in ms)

com.unblu.conversation.ui.conversationJoinTimeout

  • Type: Integer

  • Default: 20000

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in milliseconds, the UI waits while trying to join and display a conversation

Enable group conversation avatar

com.unblu.conversation.ui.enableGroupConversationAvatar

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, Unblu displays the group conversation avatar instead of a person’s avatar for conversations with more than two participants

Conversation action bar configuration

Display mode of "assign conversation to me" action

com.unblu.conversation.actionbar.ui.assignConversationToMeActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "assign conversation to me" action

com.unblu.conversation.actionbar.ui.assignConversationToMeActionSortOrder

  • Type: Integer

  • Default: 140

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "change assignee" action in the person dialog

com.unblu.conversation.actionbar.ui.changeAssigneeActionSortOrder

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "change awaited person" action

com.unblu.conversation.actionbar.ui.changeAwaitedPersonTypeActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if permission has been granted for the agent to change awaited person in the conversation configuration

Sort order for "change awaited person" action

com.unblu.conversation.actionbar.ui.changeAwaitedPersonTypeActionSortOrder

  • Type: Integer

  • Default: 45

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode of "change language" action

com.unblu.conversation.actionbar.ui.changeLanguageActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "change language" action

com.unblu.conversation.actionbar.ui.changeLanguageActionSortOrder

  • Type: Integer

  • Default: 110

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode of "change nickname" action

com.unblu.conversation.actionbar.ui.changeNicknameActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "change nickname" action

com.unblu.conversation.actionbar.ui.changeNicknameActionSortOrder

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "hide/unhide participation" action in the person dialog

com.unblu.conversation.actionbar.ui.changeParticipationVisibilityActionSortOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode of "change topic" action

com.unblu.conversation.actionbar.ui.changeTopicActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "change topic" action

com.unblu.conversation.actionbar.ui.changeTopicActionSortOrder

  • Type: Integer

  • Default: 40

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "change secondary agent visibility" action

com.unblu.conversation.actionbar.ui.changeVisibilityActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if permission to change the visibility for secondary agents has been granted in the conversation configuration

Sort order for "change secondary agent visibility" action

com.unblu.conversation.actionbar.ui.changeVisibilityActionSortOrder

  • Type: Integer

  • Default: 130

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "collapse Individual UI" action

com.unblu.conversation.actionbar.ui.collapseActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "collapse Individual UI" action

com.unblu.conversation.actionbar.ui.collapseActionSortOrder

  • Type: Integer

  • Default: 180

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "context migration co-browsing" action

com.unblu.conversation.actionbar.ui.contextMigrationCobrowsingActionDisplayMode

Only visible if: com.unblu.messenger.contextMigrationCoBrowsingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "context migration co-browsing" action

com.unblu.conversation.actionbar.ui.contextMigrationCobrowsingActionSortOrder

Only visible if: com.unblu.messenger.contextMigrationCoBrowsingEnabled=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "download message log" action

com.unblu.conversation.actionbar.ui.downloadMessageLogActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the participant has been granted permission to download the message log in the conversation configuration

downloadMessageLogActionFormat

com.unblu.conversation.actionbar.ui.downloadMessageLogActionFormat

  • Type: String with allowed values:

    • csv

    • txt

  • Default: CSV

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

What file format the exported message log should have.

Sort order for "download message log" action

com.unblu.conversation.actionbar.ui.downloadMessageLogActionSortOrder

  • Type: Integer

  • Default: 150

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "embedded co-browsing" action

com.unblu.conversation.actionbar.ui.embeddedCobrowsingActionDisplayMode

Only visible if: com.unblu.messenger.embeddedCoBrowsingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "embedded co-browsing" action

com.unblu.conversation.actionbar.ui.embeddedCobrowsingActionSortOrder

Only visible if: com.unblu.messenger.embeddedCoBrowsingEnabled=true

  • Type: Integer

  • Default: 50

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "end conversation" action

com.unblu.conversation.actionbar.ui.endConversationActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if permission has been granted for the participant to end the conversation in the conversation configuration

Sort order for "end conversation" action

com.unblu.conversation.actionbar.ui.endConversationActionSortOrder

  • Type: Integer

  • Default: 190

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "remove participant" action in the critical action section of the person dialog

com.unblu.conversation.actionbar.ui.kickParticipantActionSortOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "leave conversation" action

com.unblu.conversation.actionbar.ui.leaveConversationActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if permission has been granted for the participant to leave the conversation in the conversation configuration

Sort order for "leave conversation" action

com.unblu.conversation.actionbar.ui.leaveConversationActionSortOrder

  • Type: Integer

  • Default: 180

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "minimize/maximize Individual UI" action

com.unblu.conversation.actionbar.ui.minMaxActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "minimize/maximize Individual UI" action

com.unblu.conversation.actionbar.ui.minMaxActionSortOrder

  • Type: Integer

  • Default: 160

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode of "mobile co-browsing" action

com.unblu.conversation.actionbar.ui.mobileCoBrowsingActionDisplayMode

Only visible if: com.unblu.messenger.mobileCoBrowsingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "mobile co-browsing" action

com.unblu.conversation.actionbar.ui.mobileCoBrowsingActionSortOrder

Only visible if: com.unblu.messenger.mobileCoBrowsingEnabled=true

  • Type: Integer

  • Default: 70

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of "participant overflow" button

com.unblu.conversation.actionbar.ui.participantOverflowAvatarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of "participant overflow" button

com.unblu.conversation.actionbar.ui.participantOverflowAvatarForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "pop out Individual UI" action

com.unblu.conversation.actionbar.ui.popOutActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The action is only available in site integration implementations, and if the conversation’s "popoutEnabled" setting is true

Sort order for "pop out Individual UI" action

com.unblu.conversation.actionbar.ui.popOutActionSortOrder

  • Type: Integer

  • Default: 170

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Display mode of "screen sharing" action

com.unblu.conversation.actionbar.ui.screenSharingActionDisplayMode

Only visible if: com.unblu.messenger.screenSharingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "screen sharing" action

com.unblu.conversation.actionbar.ui.screenSharingActionSortOrder

Only visible if: com.unblu.messenger.screenSharingEnabled=true

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "back" button

com.unblu.conversation.actionbar.ui.showBackButton

  • Type: String with allowed values:

    • always

    • never

    • when_ended

  • Default: ALWAYS

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "back" button in the conversation action bar, if at all. The setting NEVER should only be used after careful consideration, since it can leave visitors stuck in a conversation.

Display mode for "show all files" action

com.unblu.conversation.actionbar.ui.showFilesActionDisplayMode

Only visible if: com.unblu.messenger.fileSharingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the permission required has been granted in the conversation configuration

Sort order for "show all files" action

com.unblu.conversation.actionbar.ui.showFilesActionSortOrder

Only visible if: com.unblu.messenger.fileSharingEnabled=true

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "universal co-browsing" action

com.unblu.conversation.actionbar.ui.universalActionDisplayMode

Only visible if: com.unblu.messenger.universalCoBrowsingEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "universal co-browsing" action

com.unblu.conversation.actionbar.ui.universalActionSortOrder

Only visible if: com.unblu.messenger.universalCoBrowsingEnabled=true

  • Type: Integer

  • Default: 80

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "video call" action

com.unblu.conversation.actionbar.ui.videoCallActionDisplayMode

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: SHOW_IF_POSSIBLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the call permissions required have been granted in the conversation configuration

Sort order for "video call" action

com.unblu.conversation.actionbar.ui.videoCallActionSortOrder

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "voice call" action

com.unblu.conversation.actionbar.ui.voiceCallActionDisplayMode

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: SHOW_IF_POSSIBLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the call permissions required have been granted in the conversation configuration

Sort order for "voice call" action

com.unblu.conversation.actionbar.ui.voiceCallActionSortOrder

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Display mode for "whiteboard" action

com.unblu.conversation.actionbar.ui.whiteboardActionDisplayMode

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: HIDDEN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The action is only available if the person also has the right to see & switch the layers

Sort order for "whiteboard" action

com.unblu.conversation.actionbar.ui.whiteboardActionSortOrder

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Integer

  • Default: 90

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call action bar UI configuration

Alignment of call action bar

com.unblu.conversation.call.actionbar.alignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: END

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Call action bar background color

com.unblu.conversation.call.actionbar.backgroundColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that the foreground is set to "DARK" or "LIGHT", as "AUTO" doesn’t work in this case.

Display mode for "background blur" action

com.unblu.conversation.call.actionbar.blurActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "background blur" action in the call action bar

Display mode for "collapse call UI" action

com.unblu.conversation.call.actionbar.collapseActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "collapse call UI" action in the call action bar

Display mode for "cycle camera" action

com.unblu.conversation.call.actionbar.cycleCameraActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_SHOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "cycle camera" action in the call action bar

Call action bar divider color

com.unblu.conversation.call.actionbar.dividerColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if "actionBarElevation" is set to "FLAT".

Call action bar elevation

com.unblu.conversation.call.actionbar.elevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: FLAT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Call action bar foreground brightness

com.unblu.conversation.call.actionbar.foreground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: LIGHT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Display mode for "open media settings" action

com.unblu.conversation.call.actionbar.mediaSettingsActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_SHOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "open media settings" action in the call action bar

Display mode for "maximize/minimize call UI" action

com.unblu.conversation.call.actionbar.minMaxActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: SHOW_IF_POSSIBLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "maximize/minimize call UI" action in the call action bar

Display mode for "personal dial into call" action

com.unblu.conversation.call.actionbar.personalDialInActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "personal dial into call" action in the call action bar

Display mode for "pop out/pop in call UI" action

com.unblu.conversation.call.actionbar.popOutActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "pop out/pop in call UI" action in the call action bar

Display mode for "take snapshot" action

com.unblu.conversation.call.actionbar.snapshotActionDisplayMode

  • Type: String with allowed values:

    • always_in_overflow

    • always_show

    • hidden

    • show_if_possible

  • Default: ALWAYS_IN_OVERFLOW

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

How to display the "take snapshot" action in the call action bar

Call shortcut configuration

Shortcut to toggle camera

com.unblu.conversation.call.shortcuts.toggleCamShortcut

  • Type: Keyboard shortcut

  • Default: $mod+e

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Make sure the shortcut isn’t already used by the browser itself and works on your keyboard layout.

Shortcut to toggle microphone

com.unblu.conversation.call.shortcuts.toggleMicShortcut

  • Type: Keyboard shortcut

  • Default: $mod+d

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Make sure the shortcut isn’t already used by the browser itself and works on your keyboard layout.

Shortcut to toggle video background blurring

com.unblu.conversation.call.shortcuts.toggleVideoBackgroundBlurShortcut

  • Type: Keyboard shortcut

  • Default: $mod+b

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Make sure the shortcut isn’t already used by the browser itself and works on your keyboard layout.

Call UI configuration

Border radius of call UI buttons

com.unblu.conversation.call.borderRadiusCallButton

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Color of "accept call" button

com.unblu.conversation.call.colorCallAcceptButton

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Call UI background color

com.unblu.conversation.call.colorCallBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundInverse\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Color of "decline call" button

com.unblu.conversation.call.colorCallDeclineButton

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightError\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

"Call type" icon background color

com.unblu.conversation.call.colorCallTypeIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary400\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Color of audio indicator in videos

com.unblu.conversation.call.colorVideoAudioIndicator

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Background color of video elements

com.unblu.conversation.call.colorVideoBackground

  • Type: Complex color

  • Default: rgba(0,0,0,0.2)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Only visible if the person isn’t sharing their camera

Background color of labels in videos

com.unblu.conversation.call.colorVideoLabelBackground

  • Type: Complex color

  • Default: rgba(0,0,0,0.6)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Foreground color of labels in videos

com.unblu.conversation.call.colorVideoLabelForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Delay before displaying "call connecting" label

com.unblu.conversation.call.displayConnectingLabelDelay

  • Type: Integer

  • Default: 3000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 60000

The label is displayed under the loading animation if connecting to an active call takes longer

Interval to display the next "call ringing" label

com.unblu.conversation.call.displayRingingLabelDelay

  • Type: Integer

  • Default: 15000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 600000

The label is displayed in the outbound call UI if a call isn’t answered

Delay for the ringing sound in the outbound call

com.unblu.conversation.call.outboundRingingDelay

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 60000

Minimized video height (in px)

com.unblu.conversation.call.videoMinimizedHeight

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Minimized video width (in px)

com.unblu.conversation.call.videoMinimizedWidth

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Call action button style

"Hovered" background color

com.unblu.conversation.call.button.action.backgroundHover

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.call.button.action.backgroundNormal\}, $alpha: 0.05)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call action" button in "hovered" state

Normal background color

com.unblu.conversation.call.button.action.backgroundNormal

  • Type: Complex color

  • Default: rgba(255,255,255,0.05)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call action" button in "normal" state

"Pressed" background color

com.unblu.conversation.call.button.action.backgroundPress

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.call.button.action.backgroundHover\}, $alpha: 0.05)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call action" button in "pressed" state

"Hovered" border color

com.unblu.conversation.call.button.action.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call action" button in "hovered" state

Normal border color

com.unblu.conversation.call.button.action.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call action" button in "normal" state

"Pressed" border color

com.unblu.conversation.call.button.action.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call action" button in "pressed" state

Border width

com.unblu.conversation.call.button.action.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "call action" button

"Hovered" foreground color

com.unblu.conversation.call.button.action.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.action.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call action" button in "hovered" state

Normal foreground color

com.unblu.conversation.call.button.action.foregroundNormal

  • Type: Complex color

  • Default: rgba(255,255,255,0.6)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call action" button in "normal" state

"Pressed" foreground color

com.unblu.conversation.call.button.action.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.action.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call action" button in "pressed" state

Call toggle button style

"Hovered" background color

com.unblu.conversation.call.button.toggle.backgroundHover

  • Type: Complex color

  • Default: rgba(255,255,255,0.05)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "hovered" state

"Hovered" background color (active)

com.unblu.conversation.call.button.toggle.backgroundHoverActive

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.call.button.toggle.backgroundNormalActive\}, $alpha:-10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "hovered (active)" state

Normal background color

com.unblu.conversation.call.button.toggle.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "normal" state

Normal background color (active)

com.unblu.conversation.call.button.toggle.backgroundNormalActive

  • Type: Complex color

  • Default: rgba(255,255,255)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "normal (active)" state

"Pressed" background color

com.unblu.conversation.call.button.toggle.backgroundPress

  • Type: Complex color

  • Default: rgba(255,255,255,0.1)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "normal" state

"Pressed" background color (active)

com.unblu.conversation.call.button.toggle.backgroundPressActive

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.call.button.toggle.backgroundNormalActive\}, $alpha:-20%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "call toggle" button in "pressed (active)" state

"Hovered" border color

com.unblu.conversation.call.button.toggle.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "hovered" state

"Hovered" border color (active)

com.unblu.conversation.call.button.toggle.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.backgroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "hovered (active)" state

Normal border color

com.unblu.conversation.call.button.toggle.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "normal" state

Normal border color (active)

com.unblu.conversation.call.button.toggle.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.backgroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "normal (active)" state

"Pressed" border color

com.unblu.conversation.call.button.toggle.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "pressed" state

"Pressed" border color (active)

com.unblu.conversation.call.button.toggle.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.backgroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "call toggle" button in "pressed (active)" state

Border width

com.unblu.conversation.call.button.toggle.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "call toggle" button

"Hovered" foreground color

com.unblu.conversation.call.button.toggle.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.conversation.call.button.toggle.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "hovered (active)" state

Normal foreground color

com.unblu.conversation.call.button.toggle.foregroundNormal

  • Type: Complex color

  • Default: rgba(255,255,255,0.5)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "normal" state

Normal foreground color (active)

com.unblu.conversation.call.button.toggle.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "normal (active)" state

"Pressed" foreground color

com.unblu.conversation.call.button.toggle.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.conversation.call.button.toggle.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.button.toggle.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "call toggle" button in "pressed (active)" state

Collaboration space UI

Color of "collaboration layer active" indicator

com.unblu.conversation.collabspace.colorLayerActiveIndicator

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Splash screen background color

com.unblu.conversation.collabspace.colorLayerLoadingSplashBackground

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray050\}, $alpha: -0.1)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the splash screen when a collaboration layer is launched

Splash screen text color

com.unblu.conversation.collabspace.colorLayerLoadingSplashForeground

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the splash screen when a collaboration layer is launched

Icon background color on splash screen

com.unblu.conversation.collabspace.colorLayerLoadingSplashIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the splash screen when a collaboration layer is launched

Splash screen icon color

com.unblu.conversation.collabspace.colorLayerLoadingSplashIconForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the splash screen when a collaboration layer is launched

Splash screen loader color

com.unblu.conversation.collabspace.colorLayerLoadingSplashLoader

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the splash screen when a collaboration layer is launched

Capturing frame color

com.unblu.conversation.collabspace.colorVisitorCapturingFrame

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The capturing frame indicates to the participant that capturing, collaboration, or sharing is taking place

Minimum time to display splash screen

com.unblu.conversation.collabspace.minLayerLoadingSplashDisplayTime

  • Type: Integer

  • Default: 2000

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Capturing frame thickness

com.unblu.conversation.collabspace.visitorCapturingFrameWidth

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The capturing frame indicates to the participant that capturing, collaboration, or sharing is taking place

Collaboration layer action button style

"Hovered" background color

com.unblu.conversation.collabspace.layer.action.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "hovered" state

"Hovered" background color (active)

com.unblu.conversation.collabspace.layer.action.backgroundHoverActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\},$alpha: 0.32)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "hovered (active)" state

Normal background color

com.unblu.conversation.collabspace.layer.action.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "normal" state

Normal background color (active)

com.unblu.conversation.collabspace.layer.action.backgroundNormalActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\},$alpha: 0.24)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "normal (active)" state

"Pressed" background color

com.unblu.conversation.collabspace.layer.action.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "pressed" state

"Pressed" background color (active)

com.unblu.conversation.collabspace.layer.action.backgroundPressActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\},$alpha: 0.40)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer action" button in "pressed (active)" state

"Hovered" border color

com.unblu.conversation.collabspace.layer.action.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "hovered" state

"Hovered" border color (active)

com.unblu.conversation.collabspace.layer.action.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "hovered (active)" state

Normal border color

com.unblu.conversation.collabspace.layer.action.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "normal" state

Normal border color (active)

com.unblu.conversation.collabspace.layer.action.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "normal (active)" state

"Pressed" border color

com.unblu.conversation.collabspace.layer.action.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "pressed" state

"Pressed" border color (active)

com.unblu.conversation.collabspace.layer.action.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer action" button in "pressed (active)" state

Border width

com.unblu.conversation.collabspace.layer.action.borderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "collaboration layer action" button

"Hovered" foreground color

com.unblu.conversation.collabspace.layer.action.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "hovered" state

Hover foreground color (active)

com.unblu.conversation.collabspace.layer.action.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "hovered (active)" state

Normal foreground color

com.unblu.conversation.collabspace.layer.action.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "normal" state

Normal foreground color (active)

com.unblu.conversation.collabspace.layer.action.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "normal (active)" state

"Pressed" foreground color

com.unblu.conversation.collabspace.layer.action.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.conversation.collabspace.layer.action.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer action" button in "pressed (active)" state

Collaboration layer button style

"Hovered" background color

com.unblu.conversation.collabspace.layer.button.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "hovered" state

"Hovered" background color (active)

com.unblu.conversation.collabspace.layer.button.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "hovered (active)" state

Normal background color

com.unblu.conversation.collabspace.layer.button.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "normal" state

Normal background color (active)

com.unblu.conversation.collabspace.layer.button.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "normal (active)" state

"Pressed" background color

com.unblu.conversation.collabspace.layer.button.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "pressed" state

"Pressed" background color (active)

com.unblu.conversation.collabspace.layer.button.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "collaboration layer" button in "pressed (active)" state

"Hovered" border color

com.unblu.conversation.collabspace.layer.button.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "hovered" state

"Hovered" border color (active)

com.unblu.conversation.collabspace.layer.button.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "hovered (active)" state

Normal border color

com.unblu.conversation.collabspace.layer.button.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "normal" state

Normal border color (active)

com.unblu.conversation.collabspace.layer.button.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "normal (active)" state

"Pressed" border color

com.unblu.conversation.collabspace.layer.button.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "pressed" state

"Pressed" border color (active)

com.unblu.conversation.collabspace.layer.button.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "collaboration layer" button in "pressed (active)" state

Border width

com.unblu.conversation.collabspace.layer.button.borderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "collaboration layer" button

"Hovered" foreground color

com.unblu.conversation.collabspace.layer.button.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.conversation.collabspace.layer.button.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "hovered (active)" state

Normal foreground color

com.unblu.conversation.collabspace.layer.button.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "normal" state

Normal foreground color (active)

com.unblu.conversation.collabspace.layer.button.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "normal (active)" state

"Pressed" foreground color

com.unblu.conversation.collabspace.layer.button.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.conversation.collabspace.layer.button.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "collaboration layer" button in "pressed (active)" state

File management UI

Maximum file size for image preview

com.unblu.conversation.file.autoLoadImagePreviewMaxBytes

  • Type: Integer

  • Default: 2000000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum size, in bytes, up to which image previews are loaded. All images greater than the specified size are not displayed as preview.

Background color of conversation files list

com.unblu.conversation.file.fileListBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Background color of my file progress bar

com.unblu.conversation.file.myFileProgressBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary300\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of my file progress bar

com.unblu.conversation.file.myFileProgressForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of other people’s file progress bar

com.unblu.conversation.file.otherFileProgressBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary300\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of other people’s file progress bar

com.unblu.conversation.file.otherFileProgressForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Messaging shortcut configuration

Shortcut to toggle messaging mode

com.unblu.conversation.messaging.shortcuts.toggleMessagingModeShortcut

  • Type: Keyboard shortcut

  • Default: $mod+m

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used to switch between public and internal messaging mode. Make sure the shortcut isn’t already used by the browser and works with your keyboard layout.

Messaging UI

Message border radius

com.unblu.conversation.messaging.ui.borderRadiusMsg

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The radius is applied to the corners of the message not pointing towards the avatar. The default value is that of the border radius component in the general UI configuration.

Message tip border radius

com.unblu.conversation.messaging.ui.borderRadiusMsgTip

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used for the message’s corner closest to the avatar

Width of bot thread vertical grouping line

com.unblu.conversation.messaging.ui.botThreadLineWidth

  • Type: Integer

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The line groups all the messages within a bot thread block. The value is specified in pixels.

Internal message input cursor color

com.unblu.conversation.messaging.ui.caretColorInternalMessageInput

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorInternalMessageInput\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The text input cursor is also referred to as the "insertion caret"

Public message input cursor color

com.unblu.conversation.messaging.ui.caretColorMessageInput

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorMessageInput\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The text input cursor is also referred to as the "insertion caret"

Threshold for "remaining characters" hint

com.unblu.conversation.messaging.ui.charactersRemainingHintThreshold

  • Type: Integer

  • Default: 200

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

When the number of remaining characters drops below the value defined here, Unblu displays the "remaining characters" hint

com.unblu.conversation.messaging.ui.chatMessageShowUrlAsLink

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Note that explicit links in Markdown messages are always displayed as links

Color of bot thread grouping line

com.unblu.conversation.messaging.ui.colorBotThreadLine

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of status icons in bot thread

com.unblu.conversation.messaging.ui.colorBotThreadStatusIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Messaging UI background color

com.unblu.conversation.messaging.ui.colorChatBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of input field for internal messages

com.unblu.conversation.messaging.ui.colorInternalMessageInputBackground

  • Type: Complex color

  • Default: #fffae8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "delivered"/"read" ticks for internal messages

com.unblu.conversation.messaging.ui.colorInternalMsgStateTick

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "delivered"/"unread" ticks for internal messages

com.unblu.conversation.messaging.ui.colorInternalMsgStateTickUnread

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray400\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "typing indicator dot" animation for internal messages

com.unblu.conversation.messaging.ui.colorInternalTypingIndicatorForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of input field for public messages

com.unblu.conversation.messaging.ui.colorMessageInputBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "delivered"/"read" ticks

com.unblu.conversation.messaging.ui.colorMsgStateTick

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "delivered"/"unread" ticks

com.unblu.conversation.messaging.ui.colorMsgStateTickUnread

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray400\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my internal messages

com.unblu.conversation.messaging.ui.colorMyInternalMsgBackground

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.colorInternalMessageInputBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my internal messages when sending message failed

com.unblu.conversation.messaging.ui.colorMyInternalMsgBackgroundFailed

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.messaging.ui.colorMyInternalMsgBackground\}, $alpha: -0.4)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my internal messages (hovered)

com.unblu.conversation.messaging.ui.colorMyInternalMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyInternalMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my internal messages (pressed)

com.unblu.conversation.messaging.ui.colorMyInternalMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyInternalMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of my internal messages

com.unblu.conversation.messaging.ui.colorMyInternalMsgBorder

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of reply to my internal message reply

com.unblu.conversation.messaging.ui.colorMyInternalMsgReplyBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyInternalMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Background color of my public sent messages

com.unblu.conversation.messaging.ui.colorMyMsgBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my public messages when sending message failed

com.unblu.conversation.messaging.ui.colorMyMsgBackgroundFailed

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.messaging.ui.colorMyMsgBackground\}, $alpha: -0.4)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my public messages (hovered)

com.unblu.conversation.messaging.ui.colorMyMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of my public messages (pressed)

com.unblu.conversation.messaging.ui.colorMyMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of my sent messages

com.unblu.conversation.messaging.ui.colorMyMsgBorder

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The default color is a light version of the primary color

Background color of reply to my public message

com.unblu.conversation.messaging.ui.colorMyMsgReplyBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Background color of internal messages from others

com.unblu.conversation.messaging.ui.colorOtherInternalMsgBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of internal messages from others (hovered)

com.unblu.conversation.messaging.ui.colorOtherInternalMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorOtherInternalMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of internal messages from others (pressed)

com.unblu.conversation.messaging.ui.colorOtherInternalMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorOtherInternalMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of internal messages from others

com.unblu.conversation.messaging.ui.colorOtherInternalMsgBorder

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorInternalMessageInputBackground\}, $lightness: -45%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of reply to internal message from others

com.unblu.conversation.messaging.ui.colorOtherInternalMsgReplyBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.backgroundLight\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Background color of public messages from others

com.unblu.conversation.messaging.ui.colorOtherMsgBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of public messages from others (hovered)

com.unblu.conversation.messaging.ui.colorOtherMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorOtherMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of public messages from others (pressed)

com.unblu.conversation.messaging.ui.colorOtherMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorOtherMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of messages from others

com.unblu.conversation.messaging.ui.colorOtherMsgBorder

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of reply to public message from others

com.unblu.conversation.messaging.ui.colorOtherMsgReplyBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.backgroundLight\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Background color of my internal message being replied to

com.unblu.conversation.messaging.ui.colorReplyingToInternalMsgBackgroundInput

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorMyInternalMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message being replied to is displayed above the input field

Background color of my public message being replied to

com.unblu.conversation.messaging.ui.colorReplyingToMsgBackgroundInput

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message being replied is displayed above the input field

Background color of internal system messages

com.unblu.conversation.messaging.ui.colorSystemInternalMsgBackground

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of internal system messages (hovered)

com.unblu.conversation.messaging.ui.colorSystemInternalMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorSystemMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of internal system messages

com.unblu.conversation.messaging.ui.colorSystemInternalMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorSystemMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of internal system messages

com.unblu.conversation.messaging.ui.colorSystemInternalMsgBorder

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of public system messages

com.unblu.conversation.messaging.ui.colorSystemMsgBackground

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of public system messages (hovered)

com.unblu.conversation.messaging.ui.colorSystemMsgBackgroundHovered

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorSystemMsgBackground\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of public system messages (pressed)

com.unblu.conversation.messaging.ui.colorSystemMsgBackgroundPressed

  • Type: Complex color

  • Default: scale-color($\{com.unblu.conversation.messaging.ui.colorSystemMsgBackgroundHovered\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of public system messages

com.unblu.conversation.messaging.ui.colorSystemMsgBorder

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of "typing indicator dot" animation

com.unblu.conversation.messaging.ui.colorTypingIndicatorForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "copy" action

com.unblu.conversation.messaging.ui.copyActionSortOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "delete" action

com.unblu.conversation.messaging.ui.deleteActionSortOrder

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "download" action

com.unblu.conversation.messaging.ui.downloadActionSortOrder

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Avatar position on message group

com.unblu.conversation.messaging.ui.groupAvatarPosition

  • Type: String with allowed values:

    • all

    • first

    • last

  • Default: LAST

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message that the avatar should be displayed on in a group of messages from the same participant

Threshold for grouping messages

com.unblu.conversation.messaging.ui.groupMessagesThreshold

  • Type: Integer

  • Default: 120000

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The threshold is specified in milliseconds. All successive messages from the same sender within the given threshold are grouped together.

Border color of empty internal message input field

com.unblu.conversation.messaging.ui.internalMessageInputBorderColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is only applied when the text input field isn’t in focus

Border color of internal message input field when errors occur

com.unblu.conversation.messaging.ui.internalMessageInputBorderColorError

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColorError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of internal message input field when in focus

com.unblu.conversation.messaging.ui.internalMessageInputBorderColorFocus

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColorFocus\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is applied irrespective of whether the input field has content or not

Border color of internal message input field with content

com.unblu.conversation.messaging.ui.internalMessageInputBorderColorNonEmpty

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is only applied when the text input field has content but isn’t in focus

Internal message input divider color

com.unblu.conversation.messaging.ui.internalMessageInputDividerColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color of the divider above the message input field for internal messages

Internal message input divider size (in px)

com.unblu.conversation.messaging.ui.internalMessageInputDividerSize

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The size in pixels of the divider above the message input field for internal messages

Image alignment in list messages

com.unblu.conversation.messaging.ui.listMessageImageAlignment

  • Type: String with allowed values:

    • left

    • right

  • Default: RIGHT

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Possible values are LEFT and RIGHT. The default value is RIGHT.

Border color of empty public message input field

com.unblu.conversation.messaging.ui.messageInputBorderColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is only applied when the text input field isn’t in focus

Border color of public message input field when errors occur

com.unblu.conversation.messaging.ui.messageInputBorderColorError

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColorError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of public message input field when in focus

com.unblu.conversation.messaging.ui.messageInputBorderColorFocus

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColorFocus\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is applied irrespective of whether the input field has content or not

Border color of public message input field with content

com.unblu.conversation.messaging.ui.messageInputBorderColorNonEmpty

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The value is applied when the text input field has content but isn’t in focus

Border radius of message input field

com.unblu.conversation.messaging.ui.messageInputBorderRadius

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the message input field

Messaging input display mode

com.unblu.conversation.messaging.ui.messageInputDisplayMode

  • Type: String with allowed values:

    • auto

    • horizontal

    • stacked

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Defines how the "send", "canned response", and "upload" buttons are positioned relative to the text input field. If set to HORIZONTAL, the buttons are positioned to the right of the text input field. If set to STACKED, the buttons are positioned below the text input field. If set to AUTO, the buttons are positioned below or to the right of the text input field, depending on the height of the chat panel. The height of the chat panel that triggers moving the buttons is configurable.

Minimum height before switching display mode

com.unblu.conversation.messaging.ui.messageInputDisplayModeAutoThreshold

  • Type: Integer

  • Default: 800

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

If the messaging component display mode is set to AUTO, the buttons appear in STACKED mode (that is, below the text input field) if the height of the chat panel is greater than the value specified here. If the height of the chat panel is smaller, the buttons are displayed in HORIZONTAL mode.

Message input divider color

com.unblu.conversation.messaging.ui.messageInputDividerColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color of the divider above the message input field

Message input divider size (in px)

com.unblu.conversation.messaging.ui.messageInputDividerSize

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The size in pixels of the divider above the message input field

Maximum height of message input field in HORIZONTAL display mode

com.unblu.conversation.messaging.ui.messageInputMaxHeightHorizontal

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The height of the input field increases to accommodate the text entered until the height specified here. The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

Maximum height of message input field in STACKED display mode

com.unblu.conversation.messaging.ui.messageInputMaxHeightStacked

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The height of the input field increases to accommodate the text entered until the height specified here. The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

Minimum height of desktop message input field in HORIZONTAL display mode

com.unblu.conversation.messaging.ui.messageInputMinHeightDesktopHorizontal

  • Type: Integer

  • Default: 32

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

Minimum height of desktop message input field in STACKED display mode

com.unblu.conversation.messaging.ui.messageInputMinHeightDesktopStacked

  • Type: Integer

  • Default: 60

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

Minimum height of mobile message input field in HORIZONTAL display mode

com.unblu.conversation.messaging.ui.messageInputMinHeightMobileHorizontal

  • Type: Integer

  • Default: 40

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

Minimum height of mobile message input field in STACKED display mode

com.unblu.conversation.messaging.ui.messageInputMinHeightMobileStacked

  • Type: Integer

  • Default: 48

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The height is specified in pixels. For information about the different display modes, refer to the description of "messaging component display mode".

"Send message" trigger

com.unblu.conversation.messaging.ui.messageInputSendBehavior

  • Type: String with allowed values:

    • on_enter

    • on_shift_enter

  • Default: ON_ENTER

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The keyboard input to send a message on. Possible values are ENTER and SHIFT + ENTER. The key combination not selected creates a new line in the message.

Minimum width for each multiple choice option button

com.unblu.conversation.messaging.ui.multiChoiceButtonMinWidth

  • Type: Integer

  • Default: 48

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Number of multiple choice option buttons to display

com.unblu.conversation.messaging.ui.multiChoiceMaxVisibleButtons

  • Type: Integer

  • Default: 6

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

If the number of multiple-choice option buttons is greater than the number specified here, the remaining options are grouped under the "More" button

Number of initially displayed messages

com.unblu.conversation.messaging.ui.numberInitiallyDisplayedMessages

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Applied to the message view when a conversation is opened. Additional messages are displayed when the user scrolls to the top of the message list. The minimum value is 50.

Number of additional messages displayed when scrolling to top

com.unblu.conversation.messaging.ui.numberOfAdditionalMessagesDisplayedWhenScrolledToTop

  • Type: Integer

  • Default: 50

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The minimum value is 10

Paragraph bottom margin (in px)

com.unblu.conversation.messaging.ui.paragraphMarginBottom

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The value is applied to the bottom of paragraphs in a message

Sort order for "reply" action

com.unblu.conversation.messaging.ui.replyActionSortOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Sort order for "start co-browsing" action

com.unblu.conversation.messaging.ui.startCobrowsingActionSortOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color used in input field for internal messages

com.unblu.conversation.messaging.ui.textColorInternalMessageInput

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Header text color of internal messages

com.unblu.conversation.messaging.ui.textColorInternalMsgHeader

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of text input field for public messages

com.unblu.conversation.messaging.ui.textColorMessageInput

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Message header text color

com.unblu.conversation.messaging.ui.textColorMsgHeader

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of body of my internal messages

com.unblu.conversation.messaging.ui.textColorMyInternalMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorMyInternalMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of reply to my internal message

com.unblu.conversation.messaging.ui.textColorMyInternalMsgReply

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorMyInternalMsgBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Text color of body of my messages

com.unblu.conversation.messaging.ui.textColorMyMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorMyMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of reply to my public message

com.unblu.conversation.messaging.ui.textColorMyMsgReply

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorMyMsgBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Text color of body of internal messages from others

com.unblu.conversation.messaging.ui.textColorOtherInternalMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorOtherInternalMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of reply to internal message from others

com.unblu.conversation.messaging.ui.textColorOtherInternalMsgReply

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorOtherInternalMsgBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Text color of body of messages from others

com.unblu.conversation.messaging.ui.textColorOtherMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorOtherMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of reply to public message from others

com.unblu.conversation.messaging.ui.textColorOtherMsgReply

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.textColorOtherMsgBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message replied to is displayed above the reply in the message list

Text color of public messages from others being replied to

com.unblu.conversation.messaging.ui.textColorReplyingToInternalMsgInput

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message being replied to is displayed above the input field

Text color of public messages from others being replied to

com.unblu.conversation.messaging.ui.textColorReplyingToMsgInput

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The message being replied to is displayed above the input field

Text color of internal system message body

com.unblu.conversation.messaging.ui.textColorSystemInternalMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorSystemInternalMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

System message body text color

com.unblu.conversation.messaging.ui.textColorSystemMsgBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

com.unblu.conversation.messaging.ui.textColorSystemMsgLink

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Header text size of internal messages

com.unblu.conversation.messaging.ui.textSizeInternalMsgHeader

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Input text size for public messages

com.unblu.conversation.messaging.ui.textSizeMessageInput

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

On iPhones, a minimum size of 16px is enforced to avoid issues caused by Safari’s auto-zoom behavior.

H1 heading size (in px)

com.unblu.conversation.messaging.ui.textSizeMsgBodyH1

  • Type: Integer

  • Default: 18

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Applied to Markdown H1 headings in the message body

H2 heading size (in px)

com.unblu.conversation.messaging.ui.textSizeMsgBodyH2

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Applied to Markdown H2 headings in the message body

H3 heading size (in px)

com.unblu.conversation.messaging.ui.textSizeMsgBodyH3

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Applied to Markdown H3 headings in the message body

Message header text size

com.unblu.conversation.messaging.ui.textSizeMsgHeader

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size for body of my internal messages

com.unblu.conversation.messaging.ui.textSizeMyInternalMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size for my messages

com.unblu.conversation.messaging.ui.textSizeMyMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size for body of internal messages from others

com.unblu.conversation.messaging.ui.textSizeOtherInternalMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size for messages from others

com.unblu.conversation.messaging.ui.textSizeOtherMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size of internal system message body

com.unblu.conversation.messaging.ui.textSizeSystemInternalMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Text size of system message body

com.unblu.conversation.messaging.ui.textSizeSystemMsgBody

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

"Send internal message" button configuration

"Hovered" background color

com.unblu.conversation.messaging.ui.send_internal_message_button.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the background of the "send internal message" button in "hovered" state

Normal background color

com.unblu.conversation.messaging.ui.send_internal_message_button.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "send internal message" button in "normal" state

"Pressed" background color

com.unblu.conversation.messaging.ui.send_internal_message_button.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "send internal message" button in "pressed" state

"Hovered" border color

com.unblu.conversation.messaging.ui.send_internal_message_button.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "send internal message" button in "hovered" state

Normal border color

com.unblu.conversation.messaging.ui.send_internal_message_button.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "send internal message" button in "normal" state

"Pressed" border color

com.unblu.conversation.messaging.ui.send_internal_message_button.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "send internal message" button in "pressed" state

Border width

com.unblu.conversation.messaging.ui.send_internal_message_button.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border width of the "send internal message" button

"Hovered" foreground color

com.unblu.conversation.messaging.ui.send_internal_message_button.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send internal message" button in "hovered" state

Normal foreground color

com.unblu.conversation.messaging.ui.send_internal_message_button.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send internal message" button in "normal" state

"Pressed" foreground color

com.unblu.conversation.messaging.ui.send_internal_message_button.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send internal message" button in "pressed" state

"Send public message" button configuration

"Hovered" background color

com.unblu.conversation.messaging.ui.send_public_message_button.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "send public message" button in "hovered" state

Normal background color

com.unblu.conversation.messaging.ui.send_public_message_button.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "send public message" button in "normal" state

"Pressed" background color

com.unblu.conversation.messaging.ui.send_public_message_button.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "send public message" button in "pressed" state

"Hovered" border color

com.unblu.conversation.messaging.ui.send_public_message_button.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send public message" button in "hovered" state

Normal border color

com.unblu.conversation.messaging.ui.send_public_message_button.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "send public message" button in "normal" state

"Pressed" border color

com.unblu.conversation.messaging.ui.send_public_message_button.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send public message" button in "pressed" state

Border width

com.unblu.conversation.messaging.ui.send_public_message_button.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border width of the "send public message" button

"Hovered" foreground color

com.unblu.conversation.messaging.ui.send_public_message_button.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send public message" button in "hovered" state

Normal foreground color

com.unblu.conversation.messaging.ui.send_public_message_button.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send public message" button in "normal" state

"Pressed" foreground color

com.unblu.conversation.messaging.ui.send_public_message_button.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.primary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "send public message" button in "pressed" state

Quick reply UI

"Hovered" background color

com.unblu.conversation.messaging.ui.quickreply.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.messaging.ui.colorMyMsgBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Normal background color

com.unblu.conversation.messaging.ui.quickreply.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Pressed" background color

com.unblu.conversation.messaging.ui.quickreply.backgroundPress

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.messaging.ui.quickreply.backgroundHover\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Hovered" border color

com.unblu.conversation.messaging.ui.quickreply.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Normal border color

com.unblu.conversation.messaging.ui.quickreply.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Pressed" border color

com.unblu.conversation.messaging.ui.quickreply.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border width

com.unblu.conversation.messaging.ui.quickreply.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

"Hovered" foreground color

com.unblu.conversation.messaging.ui.quickreply.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Normal foreground color

com.unblu.conversation.messaging.ui.quickreply.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Pressed" foreground color

com.unblu.conversation.messaging.ui.quickreply.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Style used for "quick reply" overflow button

com.unblu.conversation.messaging.ui.quickreply.overflowButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: FLAT_SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Individual UI toggle" configuration

"Hovered" background color

com.unblu.conversation.individualui.sidebar.togglebutton.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.individualui.sidebar.togglebutton.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of the "toggle Individual UI" button displayed in Agent Desk conversations in "hovered" state

Normal background color

com.unblu.conversation.individualui.sidebar.togglebutton.backgroundNormal

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of the "toggle Individual UI" button displayed in Agent Desk conversations in "normal" state

"Pressed" background color

com.unblu.conversation.individualui.sidebar.togglebutton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of the "toggle Individual UI" button displayed in Agent desk conversations in "pressed" state

"Hovered" border color

com.unblu.conversation.individualui.sidebar.togglebutton.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of the "toggle Individual UI" button displayed in Agent Desk conversations in "hovered" state

Normal border color

com.unblu.conversation.individualui.sidebar.togglebutton.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of the "toggle Individual UI" button displayed in Agent Desk conversations in "normal" state

"Pressed" border color

com.unblu.conversation.individualui.sidebar.togglebutton.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of the "toggle Individual UI" button displayed in Agent desk conversations in "pressed" state

Border radius

com.unblu.conversation.individualui.sidebar.togglebutton.borderRadius

  • Type: Integer

  • Default: 32

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the "toggle Individual UI" button in the Agent Desk conversations

Agent desk conversation individual UI toggle button style: Border width

com.unblu.conversation.individualui.sidebar.togglebutton.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

"Hovered" foreground color

com.unblu.conversation.individualui.sidebar.togglebutton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of the "toggle Individual UI" button displayed in Agent Desk conversations in "hovered" state

Normal foreground color

com.unblu.conversation.individualui.sidebar.togglebutton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of the "toggle Individual UI" button displayed in Agent Desk conversations in "normal" state

"Pressed" foreground color

com.unblu.conversation.individualui.sidebar.togglebutton.foregroundPress

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.conversation.individualui.sidebar.togglebutton.foregroundHover\},$lightness: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of the "toggle Individual UI" button displayed in Agent desk conversations in "pressed" state

Notification badge background color

com.unblu.conversation.individualui.sidebar.togglebutton.notificationBadgeColor

  • Type: Complex color

  • Default: $\{com.unblu.ui.notificationbadge.notificationBadgeBackgroundColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of the "unread message" notification badge

Login configuration

Redirect URL after logout

com.unblu.core.client.core.LoginConfiguration.externalPostLogoutUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL that the system should redirect users to after they have logged out. If not set, the system redirects users to the login page.

com.unblu.core.client.core.LoginConfiguration.signupLink

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A URL where new users can sign up

Conversation template service

Allow starting chat invite conversations

com.unblu.core.client.core.service.conversationtemplate.ConversationTemplateService.allowStartChatInviteConversations

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Allows agents to start conversations with the initial engagement type "chat invite" from the "Start conversation" menu.

Allow starting chat PIN conversations

com.unblu.core.client.core.service.conversationtemplate.ConversationTemplateService.allowStartChatPinConversations

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Allows agents to start conversations with the initial engagement type "chat PIN" from the "Start conversation" menu.

Queue icon configuration

Queue item icon background color for incoming external messenger requests

com.unblu.queue.ui.agentForwardingIconBackground

  • Type: Simple color

  • Default: #ffc1cb

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Queue item icon background color for incoming external messenger requests.

Queue item icon background color for incoming external messenger requests

com.unblu.queue.ui.agentInvitationIconBackground

  • Type: Simple color

  • Default: #fff0c2

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The background color of the queue item icon for incoming external messenger requests

Queue item icon background color for incoming audio call requests

com.unblu.queue.ui.audioCallIconBackground

  • Type: Simple color

  • Default: #c4f1b5

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Queue item icon background color for incoming audio call requests.

Queue item icon background color for incoming chat requests

com.unblu.queue.ui.chatIconBackground

  • Type: Simple color

  • Default: #e9bde0

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Queue item icon background color for incoming chat requests.

Queue item icon background color for incoming co-browsing requests

com.unblu.queue.ui.cobrowsingIconBackground

  • Type: Simple color

  • Default: #fecfb9

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the queue item icon for incoming co-browsing requests

Queue item icon background color for incoming external messenger requests

com.unblu.queue.ui.externalMessengerIconBackground

  • Type: Simple color

  • Default: #dcdce0

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the queue item icon for incoming external messenger requests

Queue item icon background color for incoming video call requests

com.unblu.queue.ui.videoCallIconBackground

  • Type: Simple color

  • Default: #b9ddf2

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the queue item for incoming video call requests

Agent admission UI

Content background color

com.unblu.agent.ui.admission.contentBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the centered content on the "Request admission", "Waiting room" and "Conversation ended" pages for agents

Conversation date and time text color

com.unblu.agent.ui.admission.textColorConversationInfoDate

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The text color of the conversation’s date and time

Conversation topic text color

com.unblu.agent.ui.admission.textColorConversationInfoTopic

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The text color of the conversation’s topic

Status information text color

com.unblu.agent.ui.admission.textColorStatusInfo

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The text color of the status information label

Title text color

com.unblu.agent.ui.admission.textColorTitle

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The text color of the title that appears on the first line of the content

Window background color

com.unblu.agent.ui.admission.windowBackground

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.dialog.ModalDialogHost.backdropColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of the "Request admission", "Waiting room", and "Conversation ended" pages for agents

Agent "conversation ended" component group

Show date

com.unblu.agent.conversationended.showDate

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show agents the start date of the conversation on the "Conversation canceled/ended" page

Show participants

com.unblu.agent.conversationended.showParticipants

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show agents the avatars and names of an ended conversation’s participants to non-participating agents

Show topic

com.unblu.agent.conversationended.showTopic

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show agents the topic of the conversation on the "Conversation canceled/ended" page

Agent "request admission" component configuration

"Cancel" and "Retry" button style

com.unblu.agent.admission.request.cancelAndRetryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Style used for the "Cancel admission request" and "Retry admission request" buttons

"Request admission" button style

com.unblu.agent.admission.request.joinConversationButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: PRIMARY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Style used for the "Request admission" button

Show date

com.unblu.agent.admission.request.showDate

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Specify whether to show the start date of the conversation to an agent before they have been granted permission to join

Show participants

com.unblu.agent.admission.request.showParticipants

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Specify whether to show the avatars and names of the conversation’s participants to the agent before they have been granted permission to join

Show topic

com.unblu.agent.admission.request.showTopic

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Specify whether to show the topic of the conversation to agents before they have been granted permission to join

Closed conversation configuration

com.unblu.desk.conversation.closed.logo

  • Type: String with allowed values:

    • account_avatar

    • brand_logo

    • brand_logo_inverse

    • named_area_avatar

    • none

  • Default: BRAND_LOGO_INVERSE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specifies which logo should be displayed at the top of "Conversation closed" page. Do not use the NAMED_AREA_AVATAR logo, as it would always fall back to ACCOUNT_AVATAR anyway.

Agent Desk UI configuration

Background color of audio call conversation tab icon

com.unblu.desk.ui.audioCallIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.audioCallIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Automatically launch PIN conversation

com.unblu.desk.ui.automaticallyStartPinConversation

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Automatically launches a new PIN-based conversation with embedded co-browsing when opening the Agent Desk

Background color of chat conversation tab icon

com.unblu.desk.ui.chatIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.chatIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Icon on conversation tabs

com.unblu.desk.ui.conversationTabIcon

  • Type: String with allowed values:

    • counterpart_avatar

    • initial_engagement_type

    • none

  • Default: COUNTERPART_AVATAR

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Default root page

com.unblu.desk.ui.defaultRootPage

  • Type: String with allowed values:

    • home

    • inbox

    • queue

    • scheduled

  • Default: INBOX

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The default root page is the one agents are redirected to, for example, when a conversation is closed

Background color of embedded co-browsing conversation tab icon

com.unblu.desk.ui.embeddedCobrowsingIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.cobrowsingIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of external messenger conversation tab icon

com.unblu.desk.ui.externalMessengerIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.externalMessengerIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of mobile co-browsing conversation tab icon

com.unblu.desk.ui.mobileCobrowsingIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.cobrowsingIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of scheduled conversation tab icon

com.unblu.desk.ui.scheduledConversationIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.audioCallIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of screen sharing conversation tab icon

com.unblu.desk.ui.screenSharingIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.cobrowsingIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show agent monitor in sidebar

com.unblu.desk.ui.showAgentAvailabilityMonitor

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show conversation history in sidebar

com.unblu.desk.ui.showConversationHistory

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show inbox in sidebar

com.unblu.desk.ui.showInbox

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show queue in sidebar

com.unblu.desk.ui.showQueue

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show scheduled conversations in sidebar

com.unblu.desk.ui.showScheduledConversations

Only visible if: com.unblu.messenger.scheduledConversationEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show chat queue

com.unblu.desk.ui.showVisitorRequestQueue

Only visible if: com.unblu.desk.ui.showQueue=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Shows visitor-initiated conversation requests in the queue

Background color of universal co-browsing conversation tab icon

com.unblu.desk.ui.universalCobrowsingIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.cobrowsingIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of video call conversation tab icon

com.unblu.desk.ui.videoCallIconBackground

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.videoCallIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color of whiteboard conversation tab icon

com.unblu.desk.ui.whiteboardIconBackground

Only visible if: com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.queue.ui.cobrowsingIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Conversation tab shortcut configuration

Shortcut to switch to 5th conversation tab

com.unblu.desk.conversationtabs.shortcuts.fifthConversationTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+5

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the fifth open conversation tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to switch to 1st conversation tab

com.unblu.desk.conversationtabs.shortcuts.firstConversationTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+1

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the first open conversation tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to switch to 4th conversation tab

com.unblu.desk.conversationtabs.shortcuts.fourthConversationTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+4

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the fourth open conversation tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to switch to 2nd conversation tab

com.unblu.desk.conversationtabs.shortcuts.secondConversationTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+2

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the second open conversation tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to switch to 3rd conversation tab

com.unblu.desk.conversationtabs.shortcuts.thirdConversationTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+3

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the third open conversation tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Conversation history configuration

exportAs

com.unblu.conversationhistory.exportAs

  • Type: String with allowed values:

    • csv

    • excel

  • Default: CSV

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The file format that the conversation history be exported as

Limit

com.unblu.conversationhistory.limit

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of records to be shown in the list

Desktop navigation shortcut configuration

Shortcut to open inbox

com.unblu.desk.leftnav.shortcuts.openInboxShortcut

  • Type: Keyboard shortcut

  • Default: alt+i

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the inbox. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to open queue

com.unblu.desk.leftnav.shortcuts.openQueueShortcut

  • Type: Keyboard shortcut

  • Default: alt+q

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the queue. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to open scheduled conversations overview

com.unblu.desk.leftnav.shortcuts.openScheduledShortcut

  • Type: Keyboard shortcut

  • Default: alt+s

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the scheduled conversations overview. Make sure it is not already used by the browser itself and works on your keyboard layout.

Queue UI

Agent actions for "inbound request" queue items

com.unblu.queue.ui.agentTargetedInboundRequestAvailableNotificationActions

  • Type: List of string with allowed values:s

    • decline

    • later

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The actions available for "inbound request" queue entries aimed at agents. "Decline" cancels the request for everyone. "Later" accepts the request internally and sends the predefined message to the conversation about dealing with the request later.

Automatically answer calls when accepting invitations

com.unblu.queue.ui.autoAnswerCallsOnAccept

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

When an agent accepts an invitation with a ringing or active call, they immediately join the call, publishing camera and microphone according to the configured defaults when they open the conversation

Enable chat preview

com.unblu.queue.ui.chatQueuePreviewEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Time until final warning is displayed on incoming requests (in s)

com.unblu.queue.ui.dangerTimeThresholdSeconds

  • Type: Integer

  • Default: 120

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Once the threshold is reached, incoming conversation that haven’t been accepted turn the "error color"

Default queue filter languages

com.unblu.queue.ui.defaultFilterLocaleLanguages

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Default named areas for queue filter

com.unblu.queue.ui.defaultFilterNamedAreas

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

"Deputy delegation" notification actions

com.unblu.queue.ui.deputyDelegationAvailableNotificationActions

  • Type: List of string with allowed values:s

    • decline

    • later

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The available actions for "deputy delegation" notifications. "Decline" declines the request for everyone. "Later" accepts the request internally and sends the predefined message to the conversation about dealing with the request later.

Enable declining invitations and forwardings from an agent

com.unblu.queue.ui.enableDeclineAgentInvitationsAndForwardings

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Allow queue filter changes

com.unblu.queue.ui.enableFilterChanges

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Allows agents to change the default queue filter in the UI

"Reserved" label background color

com.unblu.queue.ui.queueItemReservedLabelBackground

  • Type: Simple color

  • Default: #9751b9

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Background color for the "reserved" label of reserved queue items

Show icon in "danger" state

com.unblu.queue.ui.showDangerTimeIcon

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The icon is displayed behind the queue item’s waiting time

Show queue items of sub-teams

com.unblu.queue.ui.showSubTeamQueues

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Lets supervisors see the queues of their team’s sub-teams

Show icon in "warning" state

com.unblu.queue.ui.showWarnTimeIcon

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The icon is displayed behind the queue item’s waiting time

Time until first warning is displayed on incoming requests (in s)

com.unblu.queue.ui.warningTimeThresholdSeconds

  • Type: Integer

  • Default: 60

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Once the threshold is reached, incoming conversations that haven’t been accepted turn the "warning" color

Automatic request dispatching

Allow accepting inbound conversations directly with automatic dispatching

com.unblu.queue.ui.autodispatching.allowAcceptFromQueueForAutoDispatchedQueueCategories

Only visible if: com.unblu.queue.ui.autodispatching.autoRequestDispatchingEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Allow agents to accept inbound conversations directly from the queue, even if they’ve enabled automatic dispatching

Automatically dispatched queue categories

com.unblu.queue.ui.autodispatching.autoDispatchedQueueCategories

Only visible if: com.unblu.queue.ui.autodispatching.autoRequestDispatchingEnabled=true

  • Type: List of string with allowed values:s

    • inbound

    • person

    • person_deputy

    • sub_team

    • team

  • Default: INBOUND

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Queue categories that automatic dispatching is enabled for. If more than one category has pending queue items, the dispatch order is determined by this configuration property.

Enable automatic request dispatching

com.unblu.queue.ui.autodispatching.autoRequestDispatchingEnabled

Only visible if: com.unblu.desk.ui.showQueue=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Next conversation push timeout (ms)

com.unblu.queue.ui.autodispatching.nextConversationPushTimeoutAfterAccepting

Only visible if: com.unblu.queue.ui.autodispatching.autoRequestDispatchingEnabled=true

  • Type: Integer

  • Default: 2000

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in milliseconds, before a new conversation is pushed to an agent after they’ve accepted an inbound conversation

Scheduled conversation shortcut configuration

Shortcut to open "Ongoing" scheduled conversation tab

com.unblu.agent.scheduled.shortcuts.openScheduledOngoingShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+o

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the ongoing scheduled conversations tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to open "Upcoming" scheduled conversation tab

com.unblu.agent.scheduled.shortcuts.openScheduledUpcomingShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+u

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open the upcoming scheduled conversations tab. Make sure it is not already used by the browser itself and works on your keyboard layout.

Media device access

Video stream resolution

com.unblu.conversation.call.videoResolution

  • Type: String with allowed values:

    • any

    • custom

    • res_1280x720

    • res_1920x1080

    • res_320x240

    • res_640x480

  • Default: RES_1280X720

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Custom video stream resolution height

com.unblu.conversation.call.videoResolutionCustomHeight

  • Type: Integer

  • Default: 720

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 24

    • Maximum value: 7680

Only active if "videoResolution" is set to "CUSTOM"

Custom video stream resolution width

com.unblu.conversation.call.videoResolutionCustomWidth

  • Type: Integer

  • Default: 1280

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 24

    • Maximum value: 7680

Only active if "videoResolution" is set to "CUSTOM"

Reconnect feeder

Maximum reconnect attempts

com.unblu.core.client.player.reconnect.ReconnectFeeder.maxReconnectRetries

  • Type: Integer

  • Default: 15

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum number of reconnect attempts

Reconnect retry interval (ms)

com.unblu.core.client.player.reconnect.ReconnectFeeder.maxReconnectRetryIntervalMilis

  • Type: Integer

  • Default: 30000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum interval, in milliseconds, between reconnect attempts

Browser shortcut configuration

Shortcut to 5th collaboration browser tab

com.unblu.collaboration.browser.shortcuts.fifthCollaborationBrowserTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+5

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the fifth open tab in the active collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to 1st collaboration browser tab

com.unblu.collaboration.browser.shortcuts.firstCollaborationBrowserTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+1

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the first open tab in the active collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to 4th collaboration browser tab

com.unblu.collaboration.browser.shortcuts.fourthCollaborationBrowserTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+4

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the fourth open tab in the active collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to open new tab in collaboration layer

com.unblu.collaboration.browser.shortcuts.openNewTab

  • Type: Keyboard shortcut

  • Default: alt+t

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to open a new tab in a collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to 2nd collaboration browser tab

com.unblu.collaboration.browser.shortcuts.secondCollaborationBrowserTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+2

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the second open tab in the active collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Shortcut to 3rd collaboration browser tab

com.unblu.collaboration.browser.shortcuts.thirdCollaborationBrowserTabShortcut

  • Type: Keyboard shortcut

  • Default: alt+shift+3

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Keyboard shortcut to switch to the third open tab in the active collaboration layer. Make sure it is not already used by the browser itself and works on your keyboard layout.

Click feedback animation

"Click feedback" color

com.unblu.core.client.player.ui.clickfeedback.ClickFeedbackAnimation.clickFeedbackColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Co-browsing remote control "click feedback" color

Desktop box layout

Co-browsing initial layout mode

com.unblu.core.client.player.ui.desktop.DesktopBoxLayout.initialLayoutMode

  • Type: String with allowed values:

    • show_active_window

    • show_all_windows

  • Default: SHOW_ACTIVE_WINDOW

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The initial layout mode of the desktop children used when a co-browsing session is started.

Collaboration layer window layout

Co-browsing initial zoom mode

com.unblu.core.client.player.ui.desktop.DesktopLayout.initialZoomMode

  • Type: String with allowed values:

    • actual_size

    • zoom_to_fit

  • Default: ZOOM_TO_FIT

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The initial zoom mode of the desktop content used when a co-browsing session is started.

Marker configuration

Mark mode color

com.unblu.core.client.player.ui.marker.MarkerManager.markerColor

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.highlightSuccess\}, $alpha:0.8)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color that the marking dot and rectangle should have. By default, this is the "highlight success" color.

Embedded Visitor UI

Action bar background color

com.unblu.si.embedded.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.si.embedded.ui.actionBarDividerColor

  • Type: Complex color

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.si.embedded.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.si.embedded.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to "AUTO", the foreground color will be chosen based on the action bar’s background color to guarantee a maximum contrast.

Collaboration placeholder background color

com.unblu.si.embedded.ui.collaborationPlaceholderBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Collaboration space background color

com.unblu.si.embedded.ui.collaborationSpaceBackgroundColor

  • Type: Complex color

  • Default: #525659

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of collaboration layers when in an embedded environment. This is only used for layers displayed on top of the visitor page.

Enable notifications

com.unblu.si.embedded.ui.enableNotificationUi

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show notifications for new messages and calls in the Embedded Visitor UI

Key event propagation mode

com.unblu.si.embedded.ui.keyEventPropagationMode

  • Type: String with allowed values:

    • always

    • never

    • when_not_targeting_input_element

  • Default: WHEN_NOT_TARGETING_INPUT_ELEMENT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Defines whether to propagate keyup, keydown, and keypress events from the Unblu Embedded Visitor UI component to elements further up the DOM tree

Left sidebar width

com.unblu.si.embedded.ui.leftViewWidth

  • Type: Integer

  • Default: 300

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

View mode switch breakpoint

com.unblu.si.embedded.ui.switchViewModeBreakpoint

  • Type: Integer

  • Default: 768

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Element width at which to switch between split and single view. The property refers to the width of the embedded element, not the screen width.

Vertical divider color

com.unblu.si.embedded.ui.verticalDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used for the vertical divider between the left sidebar and the main view

Site integration

Key event propagation mode

com.unblu.core.client.si.floating.main.SiteIntegrationConfiguration.keyEventPropagationMode

  • Type: String with allowed values:

    • always

    • never

    • when_not_targeting_input_element

  • Default: WHEN_NOT_TARGETING_INPUT_ELEMENT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Defines whether to propagate keyup, keydown, and keypress events from the Unblu Floating Visitor UI component to elements further up the DOM tree

Enable diagnostics UI

com.unblu.core.client.si.floating.main.SiteIntegrationConfiguration.showDiagUi

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show the diagnostics button to switch between "smart snippet" mode and "escalated" mode

Single Conversation Desk configuration

Single Agent Desk redirect URL

com.unblu.agent.singleconversation.desk.conversationClosedRedirectUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The URL that the agent single conversation desk is redirected to when a conversation is closed. This setting can be overridden by using the query parameter conversationEndedRedirectUrl in the URL when opening the single conversation desk.

Redirect URL for failed agent join

com.unblu.agent.singleconversation.desk.conversationJoinFailedRedirectUrl

  • Type: String

  • Default: http://www.unblu.com

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Redirect URL for when an agent fails to join a conversation. The setting can be overridden by using the query parameter "redirectOnFailure".

Site integration UI configuration

Action bar background color

com.unblu.siteintegration.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.siteintegration.ui.actionBarDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.siteintegration.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.siteintegration.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to "AUTO", the foreground color will be chosen based on the action bar’s background color so as to guarantee a maximum contrast.

Auto-collapse Floating UI when conversation is closed

com.unblu.siteintegration.ui.autoCollapseIndividualUiWhenConversationCloses

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Collaboration space background color

com.unblu.siteintegration.ui.collaborationSpaceBackgroundColor

  • Type: Complex color

  • Default: #525659

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of collaboration layers when in a site integrated environment. This is only used for layers displayed on top of the visitor page.

Display "collapse" button if necessary

com.unblu.siteintegration.ui.enforceDisplayCollapseAction

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Display a "collapse" button in the individual UI if there is no other way available to collapse the UI. Doesn’t take into account the other "collapse" configuration properties.

Launch button border radius

com.unblu.siteintegration.ui.launcherButtonBorderRadius

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The default value draws a circle.

Launcher button border width

com.unblu.siteintegration.ui.launcherButtonBorderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

"Hovered" background color

com.unblu.siteintegration.ui.launcherButtonColorBackgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary600\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of the launcher button in "hovered" state

Normal background color

com.unblu.siteintegration.ui.launcherButtonColorBackgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of the launcher button in "normal" state

"Pressed" background color

com.unblu.siteintegration.ui.launcherButtonColorBackgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of the launcher button in "pressed" state

"Hovered" launcher button border color

com.unblu.siteintegration.ui.launcherButtonColorBorderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Border color of the launcher button border color in "hovered" state

Normal launcher button border color

com.unblu.siteintegration.ui.launcherButtonColorBorderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Border color of the launcher button in "normal" state

"Pressed" launcher button border color

com.unblu.siteintegration.ui.launcherButtonColorBorderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Border color of the launcher button in "pressed" state

"Hovered" launcher button icon and text color

com.unblu.siteintegration.ui.launcherButtonColorForegroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Icon and text color of the launcher button in "hovered" state

Launcher button icon and text color, "normal" state

com.unblu.siteintegration.ui.launcherButtonColorForegroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The icon and text color of the launcher button in the "normal" state

"Pressed" launcher button icon and text color

com.unblu.siteintegration.ui.launcherButtonColorForegroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The icon and text color of the launcher button in "pressed" state

Launcher button display mode

com.unblu.siteintegration.ui.launcherButtonDisplayMode

  • Type: String with allowed values:

    • always

    • never

    • when_agent_available

    • when_in_conversation

  • Default: ALWAYS

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to NEVER, the Unblu UI must be opened and closed via the Visitor JS API. Only set to NEVER with a corresponding API implementation.

Launcher button initial engagement icon

com.unblu.siteintegration.ui.launcherButtonIcon

  • Type: String with allowed values:

    • bell

    • camera

    • chat

    • co_browse

    • help

    • new_chat

    • phone

  • Default: CHAT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Launcher button icon size

com.unblu.siteintegration.ui.launcherButtonIconSize

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Background color of launcher button notification badge

com.unblu.siteintegration.ui.launcherButtonNotificationBadgeColorBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Text color of launcher button notification badge

com.unblu.siteintegration.ui.launcherButtonNotificationBadgeColorForeground

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Launcher button collapse icon

com.unblu.siteintegration.ui.launcherButtonOpenIcon

  • Type: String with allowed values:

    • arrow_down

    • arrow_up

    • dash

  • Default: ARROW_DOWN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Launcher button padding

com.unblu.siteintegration.ui.launcherButtonPadding

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Padding on the Unblu UI launcher button. Increasing the value makes the button bigger, decreasing it makes it smaller.

Launcher button style

com.unblu.siteintegration.ui.launcherButtonStyle

  • Type: String with allowed values:

    • icon

    • icon_and_text

    • text

  • Default: ICON

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Launcher button text size

com.unblu.siteintegration.ui.launcherButtonTextSize

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Border radius of launcher button tooltip

com.unblu.siteintegration.ui.launcherButtonTooltipBorderRadius

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The tooltip is only visible if the launcher button style is "ICON"

Background color of launcher button tooltip

com.unblu.siteintegration.ui.launcherButtonTooltipColorBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray800\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The tooltip is only visible if the launcher button style is "ICON"

Border color of launcher button tooltip

com.unblu.siteintegration.ui.launcherButtonTooltipColorBorder

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The tooltip is only visible if the launcher button style is "ICON"

Foreground color of launcher button tooltip

com.unblu.siteintegration.ui.launcherButtonTooltipColorForeground

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: INVERTED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The tooltip is only visible if the launcher button style is "ICON"

Enable tooltip on launcher button

com.unblu.siteintegration.ui.launcherButtonTooltipEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The tooltip is only visible if the launcher button style is "ICON"

Individual UI border color

com.unblu.siteintegration.ui.unbluUiBorderColor

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Floating UI border radius

com.unblu.siteintegration.ui.unbluUiBorderRadius

  • Type: Integer

  • Default: 6

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Floating UI border width

com.unblu.siteintegration.ui.unbluUiBorderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Floating UI content spacing (in px)

com.unblu.siteintegration.ui.unbluUiContentSpacing

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The spacing, in pixels, between the Floating Visitor UI and the launcher button

Floating UI default height

com.unblu.siteintegration.ui.unbluUiDefaultHeight

  • Type: Integer

  • Default: 600

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Floating UI default width

com.unblu.siteintegration.ui.unbluUiDefaultWidth

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Floating UI horizontal margin (in px)

com.unblu.siteintegration.ui.unbluUiHorizontalMargin

  • Type: Integer

  • Default: 32

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The margin, in pixels, between the Floating UI and the website’s left or right edge, depending on the UI’s configured position

Maximized Floating UI horizontal margin (in px)

com.unblu.siteintegration.ui.unbluUiHorizontalMarginMaximized

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The margin, in pixels, between the maximized Floating UI and the website’s left or right edge, depending on the UI’s configured position

Unblu UI position

com.unblu.siteintegration.ui.unbluUiPosition

  • Type: String with allowed values:

    • bottom_left

    • bottom_right

    • top_left

    • top_right

  • Default: BOTTOM_RIGHT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The position of the Unblu UI on your website

Floating UI vertical margin (in px)

com.unblu.siteintegration.ui.unbluUiVerticalMargin

  • Type: Integer

  • Default: 32

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The margin, in pixels, between the Floating UI and the website’s top or bottom edge, depending on the UI’s configured position

Maximized Floating UI vertical margin (in px)

com.unblu.siteintegration.ui.unbluUiVerticalMarginMaximized

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The margin, in pixels, between the maximized Floating UI and the website’s top or bottom edge, depending on the UI’s configured position

Client state action bar configuration

"Collapse UI" action icon

com.unblu.clientstate.actionbar.ui.collapseActionIcon

  • Type: String with allowed values:

    • arrow_down

    • arrow_up

    • dash

  • Default: ARROW_DOWN

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Icon applied to the "collapse UI" action in every action bar

Agent Desk sidebar

Color of active navigation entry

com.unblu.nav.ui.activeHighlight

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Background color of hovered navigation entry

com.unblu.nav.ui.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral800\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Background color of hovered active navigation entry

com.unblu.nav.ui.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral800\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Normal background color of navigation entry

com.unblu.nav.ui.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Normal background color of active navigation entry

com.unblu.nav.ui.backgroundNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Background color of pressed navigation entry

com.unblu.nav.ui.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral900\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Background color of pressed active navigation entry

com.unblu.nav.ui.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral900\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Border color of hovered navigation entry

com.unblu.nav.ui.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Border color of hovered active navigation entry

com.unblu.nav.ui.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Normal border color of navigation entry

com.unblu.nav.ui.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Normal border color of active navigation entry

com.unblu.nav.ui.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Border color of pressed navigation entry

com.unblu.nav.ui.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Border color of pressed active navigation entry

com.unblu.nav.ui.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Border radius of navigation entry

com.unblu.nav.ui.borderRadius

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used in the Agent Desk sidebar

Border width of navigation entry

com.unblu.nav.ui.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used in the Agent Desk sidebar

Foreground color of hovered navigation entry

com.unblu.nav.ui.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInvertedMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Foreground color of hovered active navigation entry

com.unblu.nav.ui.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Foreground color of navigation entry

com.unblu.nav.ui.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInvertedMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Normal foreground color of active navigation entry

com.unblu.nav.ui.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Foreground color of pressed navigation entry

com.unblu.nav.ui.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInvertedMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Foreground color of pressed active navigation entry

com.unblu.nav.ui.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Agent Desk sidebar background color

com.unblu.nav.ui.navBarBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Font color of navigation section header

com.unblu.nav.ui.sectionHeaderColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: INVERTED_MID

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Section header font size

com.unblu.nav.ui.sectionHeaderSize

  • Type: String with allowed values:

    • heading1

    • heading2

    • heading3

    • paragraph

    • small

    • tiny

  • Default: TINY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

Section header font weight

com.unblu.nav.ui.sectionHeaderWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: SEMIBOLD

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used in the Agent Desk sidebar

List control bar

Background color of list control bar’s "advanced" panel

com.unblu.theme.list.controlBarColorAdvancedPanelBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of list control bar

com.unblu.theme.list.controlBarColorBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of clickable list items when hovered

com.unblu.theme.list.listItemBackgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of clickable list items

com.unblu.theme.list.listItemBackgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of clickable list items when pressed

com.unblu.theme.list.listItemBackgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for list item dividers

com.unblu.theme.list.listItemDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Default list overflow behavior

com.unblu.theme.list.listItemValueOverflow

  • Type: String with allowed values:

    • clip

    • ellipsis

    • inherit

    • initial

  • Default: ELLIPSIS

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Default overflow behavior if a value in the list is too long to be displayed in full

Font for primary list item values

com.unblu.theme.list.listItemValuePrimaryFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Font for secondary list item values

com.unblu.theme.list.listItemValueSecondaryFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Info toast UI elements

Announcement toast background color

com.unblu.infotoast.ui.colorAnnouncementToastBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightAnnouncement\},$lightness: 90%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Announcement toast border color

com.unblu.infotoast.ui.colorAnnouncementToastBorder

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightAnnouncement\},$lightness: 50%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Announcement toast text color

com.unblu.infotoast.ui.colorAnnouncementToastForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Announcement toast icon color

com.unblu.infotoast.ui.colorAnnouncementToastIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Error toast background color

com.unblu.infotoast.ui.colorErrorToastBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightError\},$lightness: 90%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Error toast border color

com.unblu.infotoast.ui.colorErrorToastBorder

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightError\},$lightness: 50%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Error toast text color

com.unblu.infotoast.ui.colorErrorToastForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextError\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Error toast icon color

com.unblu.infotoast.ui.colorErrorToastIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightError\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Error toast icon color.

Neutral toast background color

com.unblu.infotoast.ui.colorNeutralToastBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Neutral toast border color

com.unblu.infotoast.ui.colorNeutralToastBorder

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Neutral toast text color

com.unblu.infotoast.ui.colorNeutralToastForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Neutral toast icon color

com.unblu.infotoast.ui.colorNeutralToastIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Success toast background color

com.unblu.infotoast.ui.colorSuccessToastBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightSuccess\},$lightness: 90%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Success toast border color

com.unblu.infotoast.ui.colorSuccessToastBorder

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightSuccess\},$lightness: 50%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Success toast text color

com.unblu.infotoast.ui.colorSuccessToastForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Success toast icon color

com.unblu.infotoast.ui.colorSuccessToastIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Warning toast background color

com.unblu.infotoast.ui.colorWarningToastBackground

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightWarning\},$lightness: 90%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Warning toast border color

com.unblu.infotoast.ui.colorWarningToastBorder

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightWarning\},$lightness: 50%)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Warning toast text color

com.unblu.infotoast.ui.colorWarningToastForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextWarn\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Warning toast icon color

com.unblu.infotoast.ui.colorWarningToastIcon

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Agent Desk top bar buttons

"Hovered" background color

com.unblu.tab.ui.button.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "top bar" button in "hovered" state

Normal background color

com.unblu.tab.ui.button.backgroundNormal

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of "top bar" buttons in "normal" state

"Pressed" background color

com.unblu.tab.ui.button.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of "top bar" buttons in "pressed" state

"Hovered" border color

com.unblu.tab.ui.button.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of "top bar" buttons in "hovered" state

Normal border color

com.unblu.tab.ui.button.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of "top bar" buttons in "normal" state

"Pressed" border color

com.unblu.tab.ui.button.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.border\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of "top bar" buttons in "pressed" state

"Hovered" foreground color

com.unblu.tab.ui.button.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of "top bar" buttons in "hovered" state

Normal foreground color

com.unblu.tab.ui.button.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of "top bar" buttons in "normal" state

"Pressed" foreground color

com.unblu.tab.ui.button.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of "top bar" buttons in "pressed" state

Agent Desk top bar tab style

com.unblu.tab.ui.link.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the top bar in the Agent Desk and Configuration interfaces

com.unblu.tab.ui.link.backgroundNormal

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color is applied to the entire top bar unless overridden, for example when a user hovers over a tab. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the top bar in the Agent Desk and Configuration interfaces

com.unblu.tab.ui.link.borderActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Applied to the bottom border of the tab that’s currently open. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.borderActiveWidth

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Applied to the top border of all tabs and the bottom border of the tab that’s currently open. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Applied to the top border of the hovered tab. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Applied to the top border of all tabs that are neither hovered nor pressed. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Applied to the top border of the pressed tab. Used for the top bar in the Agent Desk and Configuration interfaces.

com.unblu.tab.ui.link.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the top bar in the Agent Desk and Configuration interfaces

com.unblu.tab.ui.link.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the top bar in the Agent Desk and Configuration interfaces

com.unblu.tab.ui.link.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the top bar in the Agent Desk and Configuration interfaces

User menu configuration

Enable change language menu item

com.unblu.ui.usermenu.showChangeLanguage

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Change language" menu item

Show "External account analytics"

com.unblu.ui.usermenu.showExternalAccountAnalytics

Only visible if: com.unblu.analytics.grafana.enabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "External account analytics" menu item

Show "Help"

com.unblu.ui.usermenu.showHelp

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Help" menu item

Show "Keyboard shortcuts" menu item

com.unblu.ui.usermenu.showKeyboardShortcuts

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Keyboard shortcuts" menu item

Show "Manage account"

com.unblu.ui.usermenu.showManageAccount

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Manage account" menu item

Show "Canned responses"

com.unblu.ui.usermenu.showManageCannedResponses

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Canned responses" menu item

Show "Conversational bot settings"

com.unblu.ui.usermenu.showManageConversationalBot

Only visible if: com.unblu.authproxy.conversationalbot.enableConversationalBotAuthProxy is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Conversational Bot settings" menu item

Show "Deputy relationships" menu item

com.unblu.ui.usermenu.showManageDeputyRelationships

Only visible if: com.unblu.messenger.enableDeputyDelegation=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Deputy relationships" menu item

Show "Manage global server settings"

com.unblu.ui.usermenu.showManageGlobal

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Manage global server settings" menu item

Show "Manage profile"

com.unblu.ui.usermenu.showManageProfile

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Manage profile" menu item. The setting only has an effect if user profiles are managed in Unblu.

Show "Open agent desk" menu item

com.unblu.ui.usermenu.showOpenAgentDesk

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Open agent desk" menu item

Show pause notifications editor

com.unblu.ui.usermenu.showPauseNotificationsEditor

Only visible if: com.unblu.pausenotifications.enableManualPauseNotificationsMode=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "pause notifications" menu item

Show "Sign out"

com.unblu.ui.usermenu.showSignout

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the "Sign out" menu item if it is available

Show status editor item

com.unblu.ui.usermenu.showStatusEditor

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable changing online status and setting a status message in the user menu

signoutUrlForPropagatedUsers

com.unblu.ui.usermenu.signoutUrlForPropagatedUsers

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The signout URL to be used for users logged in via ID propagation

Set target URL for custom help

com.unblu.ui.usermenu.uriHelp

The target URL called when agents click on the "Help" menu item. If the URL includes a ${lang} placeholder, the placeholder is replaced with a two-letter language code, e.g. "de" or "en".

Fallback language for help URL

com.unblu.ui.usermenu.uriHelpFallbackLanguage

  • Type: String

  • Default: en

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Specify the fallback language of the help URL, if the language requested is not supported

Supported languages for help URL

com.unblu.ui.usermenu.uriHelpSupportedLanguages

  • Type: List of strings

  • Default: en

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The languages supported by the help URL

Enable user menu

com.unblu.ui.usermenu.userMenuEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the user menu. If set to 'false', the setting disables the entire menu. This may be useful in single sign-on (SSO) implementations.

Audio notification settings

The agent’s "message sent" notification sound

com.unblu.core.client.ui.audio.chatMessageSentAgentSide

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: NOTIFICATION_SWOOSH

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

"Message sent" notification sound (agent)

The visitor’s "message sent" notification sound

com.unblu.core.client.ui.audio.chatMessageSentClientSide

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: NOTIFICATION_SWOOSH

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Message sent" notification sound (visitor)

"Incoming call" notification sound

com.unblu.core.client.ui.audio.incomingCall

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: CALL_TUBES_SMALL

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Layer inactivity" notification sound

com.unblu.core.client.ui.audio.layerInactivityNotificationSound

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: NOTIFICATION_SOFTUP

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Layer inactivity" notification sound (agent)

"New message received" notification sound (agent)

com.unblu.core.client.ui.audio.newChatMessageAgentSide

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: NOTIFICATION_GLASS

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"New chat queue item" notification sound

com.unblu.core.client.ui.audio.newInQueueNotificationSound

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: INCOMING_GLASS

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Notification sound for new conversations in the queue and for automatically dispatched conversations

"Outgoing call" notification sound

com.unblu.core.client.ui.audio.outgoingCall

  • Type: String with allowed values:

    • call_space

    • call_tubes_big

    • call_tubes_small

    • call_wood

    • incoming_enigmatic

    • incoming_glass

    • incoming_space

    • incoming_spaceball

    • incoming_wood

    • none

    • notification_glass

    • notification_harpup

    • notification_softbell

    • notification_softup

    • notification_spaceball

    • notification_swoosh

    • notification_toy

  • Default: CALL_TUBES_BIG

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Avatar configuration

Dark background color of online state indicator when away

com.unblu.avatar.ui.awayOnDarkBg

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is away and the avatar is in front of a dark background

Light background color of online state indicator when away

com.unblu.avatar.ui.awayOnLightBg

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.avatar.ui.awayOnDarkBg\},$lightness: -12%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is away and the avatar is in front of a light background

Background color of avatar overlay for hidden participants

com.unblu.avatar.ui.hiddenOverlayBg

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.7)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Foreground color of avatar overlay for hidden participants

com.unblu.avatar.ui.hiddenOverlayFg

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Dark background color of online state indicator when offline

com.unblu.avatar.ui.offlineOnDarkBg

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is offline and the avatar is in front of a dark background

Light background color of online state indicator when offline

com.unblu.avatar.ui.offlineOnLightBg

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is offline and the avatar is in front of a light background

Dark background color of online state indicator when online

com.unblu.avatar.ui.onlineOnDarkBg

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is online and the avatar is in front of a dark background

Light background color of online state indicator when online

com.unblu.avatar.ui.onlineOnLightBg

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.avatar.ui.onlineOnDarkBg\},$lightness: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the avatar’s online state indicator when the person is online and the avatar is in front of a light background

Show offline symbol

com.unblu.avatar.ui.showOfflineSymbol

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Displays an offline icon on a person’s avatar when they’re offline

Show online state indicator

com.unblu.avatar.ui.showOnlineStateIndicator

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Displays the online state of agents and visitors in the avatar and related texts

Banners

"Announcement" banner background color

com.unblu.core.client.ui.banner.color.backgroundAnnouncement

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Error" banner background color

com.unblu.core.client.ui.banner.color.backgroundError

  • Type: Complex color

  • Default: #bf0f26

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Neutral" banner background color

com.unblu.core.client.ui.banner.color.backgroundNeutral

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Success" banner background color

com.unblu.core.client.ui.banner.color.backgroundSuccess

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Warning" banner background color

com.unblu.core.client.ui.banner.color.backgroundWarning

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Announcement" banner border color

com.unblu.core.client.ui.banner.color.borderAnnouncement

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.backgroundAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Error" banner border color

com.unblu.core.client.ui.banner.color.borderError

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.backgroundError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Neutral" banner border color

com.unblu.core.client.ui.banner.color.borderNeutral

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.backgroundNeutral\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Success" banner border color

com.unblu.core.client.ui.banner.color.borderSuccess

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.backgroundSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Warning" banner border color

com.unblu.core.client.ui.banner.color.borderWarning

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.backgroundWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border width for all banners

com.unblu.core.client.ui.banner.color.borderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

"Announcement" banner font color

com.unblu.core.client.ui.banner.color.fontAnnouncement

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Error" banner font color

com.unblu.core.client.ui.banner.color.fontError

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Neutral" banner font color

com.unblu.core.client.ui.banner.color.fontNeutral

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Success" banner font color

com.unblu.core.client.ui.banner.color.fontSuccess

  • Type: Complex color

  • Default: #00331a

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Warning" banner font color

com.unblu.core.client.ui.banner.color.fontWarning

  • Type: Complex color

  • Default: #403106

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Announcement" banner icon color

com.unblu.core.client.ui.banner.color.iconAnnouncement

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.fontAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Error" banner icon color

com.unblu.core.client.ui.banner.color.iconError

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.fontError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Neutral" banner icon color

com.unblu.core.client.ui.banner.color.iconNeutral

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.fontNeutral\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Success" banner icon color

com.unblu.core.client.ui.banner.color.iconSuccess

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.fontSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Warning" banner icon color

com.unblu.core.client.ui.banner.color.iconWarning

  • Type: Complex color

  • Default: $\{com.unblu.core.client.ui.banner.color.fontWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

PlaceholderButtonConfiguration

Hover background color

com.unblu.placeholder.button.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "placeholder" button in "hovered" state

Normal background color

com.unblu.placeholder.button.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "placeholder" button in "normal" state

Press background color

com.unblu.placeholder.button.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "placeholder" button in "pressed" state

Hover border color

com.unblu.placeholder.button.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.placeholder.button.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "placeholder" button in "hovered" state

Normal border color

com.unblu.placeholder.button.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.placeholder.button.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "placeholder" button in "normal" state

Press border color

com.unblu.placeholder.button.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.placeholder.button.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "placeholder" button in "pressed" state

Border width

com.unblu.placeholder.button.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "placeholder" button

Hover foreground color

com.unblu.placeholder.button.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.placeholder.button.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "placeholder" button in "hovered" state

Normal foreground color

com.unblu.placeholder.button.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "placeholder" button in "normal" state

Press foreground color

com.unblu.placeholder.button.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.placeholder.button.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "placeholder" button in "pressed" state

Modal dialog configuration

Radial gradient outer color for modal dialog backdrops

com.unblu.core.client.ui.dialog.ModalDialogHost.backdropColor

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral300\},$alpha:-0.30)

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Radial gradient outer color used for modal dialog backdrops

Scroll lock when dialog open

com.unblu.core.client.ui.dialog.ModalDialogHost.lockScrollingWhenDialogOpen

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, scrolling will be locked on the window as soon as a dialog is opened using event listeners. The scroll lock will be reverted when the dialog closes.

UI notifications

Auto-hide timeout for toast notifications (in ms)

com.unblu.core.toaster.autoHideTimeout

  • Type: Integer

  • Default: 5000

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Timeout, in milliseconds, before web notifications and toasts are automatically hidden

Local toast notifications

Toast notifications horizontal alignment

com.unblu.core.client.ui.notification.NotificationService.toastNotificationAlignmentX

  • Type: String with allowed values:

    • left

    • middle

    • right

  • Default: LEFT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Define where toast notifications should be displayed horizontally. Possible values are LEFT, MIDDLE, and RIGHT.

Toast notifications vertical alignment

com.unblu.core.client.ui.notification.NotificationService.toastNotificationAlignmentY

  • Type: String with allowed values:

    • bottom

    • middle

    • top

  • Default: BOTTOM

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Defines where notification toasts should be displayed vertically. Possible values are TOP, MIDDLE, and BOTTOM.

Maximum number of toasts

com.unblu.core.toaster.maxItemsShown

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum number of notification toasts shown

Notification toasts

Notification toast background color

com.unblu.notification.ui.notificationBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Notification toast border color

com.unblu.notification.ui.notificationBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.notification.ui.notificationBackgroundColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Notification toast border width

com.unblu.notification.ui.notificationBorderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color for "admission request" notification toast icon

com.unblu.notification.ui.notificationIconBackgroundColorAdmissionRequest

  • Type: Simple color

  • Default: ` #CBB1E6`

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color for "incoming call" notification toast icon

com.unblu.notification.ui.notificationIconBackgroundColorIncomingCall

  • Type: Simple color

  • Default: ` #BBBBBB`

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color for "incoming queue conversation" notification toast icon

com.unblu.notification.ui.notificationIconBackgroundColorIncomingConversation

  • Type: Simple color

  • Default: ` #BBBBBB`

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color for "new message" notification toast icon

com.unblu.notification.ui.notificationIconBackgroundColorNewMessage

  • Type: Simple color

  • Default: ` #FFF0C5`

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Notification toast icon color

com.unblu.notification.ui.notificationIconColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Notification toast text color

com.unblu.notification.ui.notificationTextColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Notification toast title color

com.unblu.notification.ui.notificationTitleColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Tooltip configuration

Background color of tooltips

com.unblu.core.client.ui.popup.tooltip.tooltipBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray800\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Tooltip background color

Time before tooltip

com.unblu.core.client.ui.popup.tooltip.tooltipDisplayTimeoutMillis

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The time delay before a tooltip is shown when the cursor is hovering over an item

Foreground color of tooltips

com.unblu.core.client.ui.popup.tooltip.tooltipForegroundColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: INVERTED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Tooltip foreground color

Scroll Indicator

Bottom scroll indicator shadow color

com.unblu.ui.scrollindicator.scrollIndicatorShadowColorBottom

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.shadow\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color of the shadow displayed at the bottom of a scrollable element that isn’t scrolled all the way to the bottom

Top scroll indicator shadow color

com.unblu.ui.scrollindicator.scrollIndicatorShadowColorTop

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.shadow\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The color of the shadow displayed at the top of a scrollable element that isn’t scrolled all the way to the top

Bottom scroll indicator shadow size (in px)

com.unblu.ui.scrollindicator.scrollIndicatorShadowSizeBottom

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The size, in pixels, of the shadow displayed at the bottom of a scrollable element that isn’t scrolled all the way to the bottom

Top scroll indicator shadow size (in px)

com.unblu.ui.scrollindicator.scrollIndicatorShadowSizeTop

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 48

The size, in pixels, of the shadow displayed at the top of a scrollable element that isn’t scrolled all the way to the top

Custom select box style

Background color when hovered

com.unblu.theme.select.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Background color

com.unblu.theme.select.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Background color when pressed

com.unblu.theme.select.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Border color when hovered

com.unblu.theme.select.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Border color

com.unblu.theme.select.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Border color when pressed

com.unblu.theme.select.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.input.borderColor\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Border width

com.unblu.theme.select.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Foreground color when hovered

com.unblu.theme.select.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Foreground color

com.unblu.theme.select.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Font color for placeholder text

com.unblu.theme.select.foregroundPlaceholder

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray600\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

Foreground color when pressed

com.unblu.theme.select.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Only affects custom elements that replicate the behavior of select elements, not native browser select elements

ShortcutToggleButtonConfiguration

Hover background color

com.unblu.shortcut.meta.toggle.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "hovered" state

Hover background color (active)

com.unblu.shortcut.meta.toggle.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "hovered (active)" state

Normal background color

com.unblu.shortcut.meta.toggle.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "normal" state

Normal background color (active)

com.unblu.shortcut.meta.toggle.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "normal (active)" state

Press background color

com.unblu.shortcut.meta.toggle.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "pressed" state

Press background color (active)

com.unblu.shortcut.meta.toggle.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "shortcut toggle" button in "pressed (active)" state

Hover border color

com.unblu.shortcut.meta.toggle.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "hovered" state

Hover border color (active)

com.unblu.shortcut.meta.toggle.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "hovered (active)" state

Normal border color

com.unblu.shortcut.meta.toggle.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "normal" state

Normal border color (active)

com.unblu.shortcut.meta.toggle.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "normal (active)" state

Press border color

com.unblu.shortcut.meta.toggle.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "pressed" state

Press border color (active)

com.unblu.shortcut.meta.toggle.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.backgroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "shortcut toggle" button in "pressed (active)" state

Border width

com.unblu.shortcut.meta.toggle.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "shortcut toggle" button

Hover foreground color

com.unblu.shortcut.meta.toggle.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "hovered" state

Hover foreground color (active)

com.unblu.shortcut.meta.toggle.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "hovered (active)" state

Normal foreground color

com.unblu.shortcut.meta.toggle.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray400\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "normal" state

Normal foreground color (active)

com.unblu.shortcut.meta.toggle.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "normal (active)" state

Press foreground color

com.unblu.shortcut.meta.toggle.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "pressed" state

Press foreground color (active)

com.unblu.shortcut.meta.toggle.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.shortcut.meta.toggle.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "shortcut toggle" button in "pressed (active)" state

Indicator widget for blocked events

"Blocked event" indicator fade-out time

com.unblu.core.client.ui.widgets.BlockedEventIndicator.fadeTimeout

  • Type: Float

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Duration in seconds of the fading animation for the "blocked event" indicator

"Unread messages" notification badge

Background color of "unread messages" notification badge

com.unblu.ui.notificationbadge.notificationBadgeBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of "unread messages" notification badge

com.unblu.ui.notificationbadge.notificationBadgeForegroundColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Visitor activity trigger

Activity trigger URL

com.unblu.visitor.activity.activityTriggerUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The URL is triggered whenever a visitor interacts with Unblu

Throttle activity trigger for URL (in s)

com.unblu.visitor.activity.activityTriggerUrlThrottlingInSeconds

  • Type: Integer

  • Default: 60

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

If a URL has been configured to trigger on activity, it isn’t triggered more often than this configured time (in seconds). The minimum value is 10 seconds.

Visitor UI

Display recipient in overview instead of assigned agent

com.unblu.visitor.ui.alwaysDisplayRecipientInConversationOverview

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of conversation overview list

com.unblu.visitor.ui.conversationListBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font color for time and last message when message is read

com.unblu.visitor.ui.conversationListColorRead

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font color for time and last message when message is unread

com.unblu.visitor.ui.conversationListColorUnread

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for sender of last message

com.unblu.visitor.ui.conversationListLastMsgSenderFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY_ITALIC

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for text of last message

com.unblu.visitor.ui.conversationListLastMsgTextFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used in the conversation list for the last message time

com.unblu.visitor.ui.conversationListLastMsgTimeFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for last message timestamp

Background color of unread message notification badge

com.unblu.visitor.ui.conversationListNotificationBadgeBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font color for number of unread messages in notification badge

com.unblu.visitor.ui.conversationListNotificationBadgeForegroundColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation title font

com.unblu.visitor.ui.conversationListTitleFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used in the conversation list for the conversation title, which is usually the name of the assigned agent

Font for secondary title

com.unblu.visitor.ui.conversationListTitleSecondaryFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used in the conversation list for the secondary title (usually the recipient’s name)

Display secondary title in conversation overview

com.unblu.visitor.ui.displaySecondaryTitleInConversationOverview

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If the conversation has both a topic and an assigned agent, the secondary title is the assigned agent’s name, otherwise it will be the recipient’s name. If the conversation has neither a topic nor an assigned agent, it won’t have a secondary title.

Ended conversations display mode

com.unblu.visitor.ui.endedConversationsDisplayMode

  • Type: String with allowed values:

    • inline

    • in_archive

  • Default: INLINE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specifies whether to display ended conversations in the same conversation list in the visitor UI. If displayed in a single list, ended conversations are grayed out in the conversation list.

Open new call conversation requests in pop-out

com.unblu.visitor.ui.openNewCallRequestConversationInPopout

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If enabled, new call conversation requests automatically open in a popout on the visitor’s side

Background color of conversation overview loading overlay.

com.unblu.visitor.ui.overviewLoadingBackgroundColor

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral900\}, $alpha:0.6)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Foreground color of conversation overview loading overlay.

com.unblu.visitor.ui.overviewLoadingForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Default height of call pop-out window

com.unblu.visitor.ui.popoutHeight

  • Type: Integer

  • Default: 800

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Default width of call pop-out window

com.unblu.visitor.ui.popoutWidth

  • Type: Integer

  • Default: 480

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Show overview action bar in visitor overview

com.unblu.visitor.ui.showOverviewActionBar

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show "change nickname" action in visitors' overview action bar

com.unblu.visitor.ui.showOverviewActionBarChangeNicknameAction

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The action lets anonymous visitors change their nickname

Show "collapse" action in overview action bar

com.unblu.visitor.ui.showOverviewActionBarCollapseAction

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show "minimize/maximize Individual UI" action in overview action bar

com.unblu.visitor.ui.showOverviewActionBarMinMaxAction

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Visitor conversation UI

Embedded UI chat width

com.unblu.visitor.conversation.ui.collapsableEmbeddedIndividualUiWidth

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width of the chat panel in the Embedded UI during collaboration sessions. This width applies when the chat is docked to the right.

Background color of layer controls

com.unblu.visitor.conversation.ui.layerControlsBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color of layer controls drag handle

com.unblu.visitor.conversation.ui.layerControlsDragHandleColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Initial alignment of layer controls

com.unblu.visitor.conversation.ui.layerControlsInitialAlignment

  • Type: String with allowed values:

    • center

    • left

    • right

  • Default: CENTER

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Initial position of layer controls

com.unblu.visitor.conversation.ui.layerControlsInitialPosition

  • Type: String with allowed values:

    • bottom

    • top

  • Default: TOP

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Visitor layer controls toggle button

"Hovered" background color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.conversation.collabspace.colorVisitorCapturingFrame\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor layer controls toggle" button in "hovered" state. This button should only be used for small devices.

Normal background color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.conversation.collabspace.colorVisitorCapturingFrame\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor layer controls toggle" button in "normal" state. This button should only be used for small devices.

"Pressed" background color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.conversation.collabspace.colorVisitorCapturingFrame\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor layer controls toggle" button in "pressed" state. This button should only be used for small devices.

Border radius

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.borderRadius

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the "visitor layer controls toggle" button. This button should only be used for small devices.

Border width

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.borderWidth

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "visitor layer controls toggle" button. This button should only be used for small devices.

"Hovered" foreground color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor layer controls toggle" button in "hovered" state. This button should only be used for small devices.

Normal foreground color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor layer controls toggle" button in "normal" state. This button should only be used for small devices.

"Pressed" foreground color

com.unblu.visitor.conversation.ui.layercontrols.togglebutton.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor layer controls toggle" button in "pressed" state. This button should only be used for small devices.

Visitor collaboration layer select button style

"Hovered" background color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "hovered" state

"Hovered" background color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "hovered (active)" state

Normal background color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "normal" state

Normal background color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "normal (active)" state

"Pressed" background color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "pressed" state

"Pressed" background color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.backgroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor collaboration layer menu" button in "pressed (active)" state

"Hovered" border color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "hovered" state

"Hovered" border color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "hovered (active)" state

Normal border color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "normal" state

Normal border color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "normal (active)" state

"Pressed" border color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "pressed" state

"Pressed" border color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor collaboration layer menu" button in "pressed (active)" state

Border width

com.unblu.visitor.conversation.ui.layercontrols.menubutton.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "visitor collaboration layer menu" button

"Hovered" foreground color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "hovered (active)" state

Normal foreground color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "normal" state

Normal foreground color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "normal (active)" state

"Pressed" foreground color

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.visitor.conversation.ui.layercontrols.menubutton.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.foregroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor collaboration layer menu" button in "pressed (active)" state

Engagement UI

Background color of engagement panel when agents are available

com.unblu.visitor.ui.engagement.agentAvailableBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for engagement UI body when agents are available

com.unblu.visitor.ui.engagement.agentAvailableBodyFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Style of engagement UI flat buttons when agents are available

com.unblu.visitor.ui.engagement.agentAvailableFlatButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: FLAT_SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for engagement panel heading when agents are available

com.unblu.visitor.ui.engagement.agentAvailableHeadingFont

  • Type: String with allowed values:

    • h1

    • h1_inverted

    • h2

    • h2_inverted

    • h3

    • h3_inverted

  • Default: H1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

com.unblu.visitor.ui.engagement.agentAvailableLogo

  • Type: String with allowed values:

    • account_avatar

    • brand_logo

    • brand_logo_inverse

    • named_area_avatar

    • none

  • Default: BRAND_LOGO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Agent available" logo alignment

com.unblu.visitor.ui.engagement.agentAvailableLogoAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Style of engagement panel primary buttons when agents are available

com.unblu.visitor.ui.engagement.agentAvailablePrimaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: PRIMARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Style of engagement panel secondary buttons when agents are available

com.unblu.visitor.ui.engagement.agentAvailableSecondaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Agent available" subtitle alignment

com.unblu.visitor.ui.engagement.agentAvailableSubtitleAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

END, MIDDLE, and START align the text of the subtitle to the left, center, or right of the engagement UI, respectively.

"Agent available" title alignment

com.unblu.visitor.ui.engagement.agentAvailableTitleAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

END, MIDDLE, and START align the text of the subtitle to the left, center, or right of the engagement UI, respectively.

Background gradient angle of engagement panel when no agents are available

com.unblu.visitor.ui.engagement.agentAwayBackgroundAngle

  • Type: Integer

  • Default: 180

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Background gradient end color of engagement panel when no agents are available

com.unblu.visitor.ui.engagement.agentAwayBackgroundEnd

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background gradient start color of engagement panel when no agents are available

com.unblu.visitor.ui.engagement.agentAwayBackgroundStart

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Body font if agent is away

com.unblu.visitor.ui.engagement.agentAwayBodyFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The font is used in the body of the engagement UI

Style of engagement panel flat buttons when no agents are available

com.unblu.visitor.ui.engagement.agentAwayFlatButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: FLAT_SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for engagement UI heading when no agents are available

com.unblu.visitor.ui.engagement.agentAwayHeadingFont

  • Type: String with allowed values:

    • h1

    • h1_inverted

    • h2

    • h2_inverted

    • h3

    • h3_inverted

  • Default: H1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

com.unblu.visitor.ui.engagement.agentAwayLogo

  • Type: String with allowed values:

    • account_avatar

    • brand_logo

    • brand_logo_inverse

    • named_area_avatar

    • none

  • Default: BRAND_LOGO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Agent away" logo alignment

com.unblu.visitor.ui.engagement.agentAwayLogoAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Style of engagement panel primary buttons when no agents are available

com.unblu.visitor.ui.engagement.agentAwayPrimaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: PRIMARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Style of engagement UI secondary buttons when no agents are available

com.unblu.visitor.ui.engagement.agentAwaySecondaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"Agent away" subtitle alignment

com.unblu.visitor.ui.engagement.agentAwaySubtitleAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

END, MIDDLE, and START align the text of the subtitle to the left, center, or right of the engagement UI, respectively.

"Agent away" title alignment

com.unblu.visitor.ui.engagement.agentAwayTitleAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

END, MIDDLE, and START align the text of the subtitle to the left, center, or right of the engagement UI, respectively.

Make "audio call" primary engagement option

com.unblu.visitor.ui.engagement.makeAudioCallPrimary

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If enabled, the option appears as a primary button in the engagement UI

Make "chat" primary engagement option

com.unblu.visitor.ui.engagement.makeChatEngagementPrimary

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If enabled, the option appears as a primary button in the engagement UI

Make "video call" primary engagement option

com.unblu.visitor.ui.engagement.makeVideoCallPrimary

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If enabled, the option appears as a primary button in the engagement UI

Show "audio call" engagement option

com.unblu.visitor.ui.engagement.showAudioCallEngagementOption

Only visible if: com.unblu.messenger.startWithAudioCallOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "audio" and "start with audio call" options must also be enabled

Show "chat" engagement option

com.unblu.visitor.ui.engagement.showChatEngagementOption

Only visible if: com.unblu.messenger.startWithChatOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "chat" and "start with chat" options must also be enabled

Show "offline chat" engagement option

com.unblu.visitor.ui.engagement.showOfflineChatEngagementOption

Only visible if: com.unblu.messenger.startWithOfflineChatOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "chat" and "start with offline chat" options must also be enabled

Show "PIN" engagement option

com.unblu.visitor.ui.engagement.showPinEngagementOption

Only visible if: com.unblu.messenger.startWithTalkOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with PIN" option must also be enabled

Show "request embedded co-browsing" engagement option

com.unblu.visitor.ui.engagement.showRequestEmbeddedCobrowsingEngagementOption

Only visible if: com.unblu.messenger.startWithEmbeddedCobrowsingOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with embedded co-browsing" option must also be enabled

Show "request mobile co-browsing" option

com.unblu.visitor.ui.engagement.showRequestMobileCobrowsingEngagementOption

Only visible if: com.unblu.messenger.startWithMobileCobrowsingOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with mobile co-browsing" option must also be enabled

Show "request screen sharing" engagement option

com.unblu.visitor.ui.engagement.showRequestScreenSharingEngagementOption

Only visible if: com.unblu.messenger.startWithScreenSharingOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with screen sharing" option must also be enabled

Show "request universal co-browsing" engagement option

com.unblu.visitor.ui.engagement.showRequestUniversalCobrowsingEngagementOption

Only visible if: com.unblu.messenger.startWithUniversalCobrowsingOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with universal co-browsing" option must also be enabled

Show "whiteboard request" engagement option

com.unblu.visitor.ui.engagement.showRequestWhiteboardEngagementOption

Only visible if: com.unblu.messenger.startWithWhiteboardOptionEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "start with whiteboard" and "enable preview" options must also be enabled

Show "video call" engagement option

com.unblu.visitor.ui.engagement.showVideoCallEngagementOption

Only visible if: com.unblu.messenger.startWithVideoCallOptionEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The "video" and "start with video call" options must also be enabled

Visitor-side PIN UI

Display back button in action bar

com.unblu.visitor.ui.pinentry.allowBack

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The back button lets visitors navigate to the conversation overview. Warning: Don’t disable this if you don’t know what you are doing!

Background color of PIN entry screen

com.unblu.visitor.ui.pinentry.backgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for PIN entry body

com.unblu.visitor.ui.pinentry.bodyFont

  • Type: String with allowed values:

    • body

    • body_inverted

    • body_italic

    • dark

    • dark_inverted

    • link

    • link_dark

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font for PIN entry heading

com.unblu.visitor.ui.pinentry.headingFont

  • Type: String with allowed values:

    • h1

    • h1_inverted

    • h2

    • h2_inverted

    • h3

    • h3_inverted

  • Default: H1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

com.unblu.visitor.ui.pinentry.logo

  • Type: String with allowed values:

    • account_avatar

    • brand_logo

    • brand_logo_inverse

    • named_area_avatar

    • none

  • Default: NONE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font color of PIN input

com.unblu.visitor.ui.pinentry.pinInputFontColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font size of PIN input

com.unblu.visitor.ui.pinentry.pinInputFontSize

  • Type: String with allowed values:

    • heading1

    • heading2

    • heading3

    • paragraph

    • small

    • tiny

  • Default: HEADING1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Font weight of PIN input

com.unblu.visitor.ui.pinentry.pinInputFontWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: SEMIBOLD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

PIN input field padding

com.unblu.visitor.ui.pinentry.pinInputPadding

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

PIN input field width

com.unblu.visitor.ui.pinentry.pinInputWidth

  • Type: Integer

  • Default: 128

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Show collapse action in PIN component action bar

com.unblu.visitor.ui.showPinComponentActionBarCollapseAction

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show "Maximize/minimize Individual UI" action in PIN component action bar

com.unblu.visitor.ui.showPinComponentActionBarMinMaxAction

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Visitor conversation list toggle button style

"Hovered" background color

com.unblu.visitor.conversationlist.toggle.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "hovered" state

"Hovered" background color (active)

com.unblu.visitor.conversationlist.toggle.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "hovered (active)" state

Normal background color

com.unblu.visitor.conversationlist.toggle.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "normal" state

Normal background color (active)

com.unblu.visitor.conversationlist.toggle.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "normal (active)" state

"Pressed" background color

com.unblu.visitor.conversationlist.toggle.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "pressed" state

"Pressed" background color (active)

com.unblu.visitor.conversationlist.toggle.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.backgroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "visitor conversation list toggle" button in "pressed (active)" state

"Hovered" border color

com.unblu.visitor.conversationlist.toggle.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "hovered" state

"Hovered" border color (active)

com.unblu.visitor.conversationlist.toggle.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "hovered (active)" state

Normal border color

com.unblu.visitor.conversationlist.toggle.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "normal" state

Normal border color (active)

com.unblu.visitor.conversationlist.toggle.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "normal (active)" state

"Pressed" border color

com.unblu.visitor.conversationlist.toggle.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "pressed" state

"Pressed" border color (active)

com.unblu.visitor.conversationlist.toggle.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "visitor conversation list toggle" button in "pressed (active)" state

Border width

com.unblu.visitor.conversationlist.toggle.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "visitor conversation list toggle" button

Gap between "active" and "archived" buttons (in px)

com.unblu.visitor.conversationlist.toggle.buttonGap

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The width, in pixels, of the horizontal gap between the "active" and "archived" buttons in the conversation list

"Hovered" foreground color

com.unblu.visitor.conversationlist.toggle.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.visitor.conversationlist.toggle.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundHoverActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "hovered (active)" state

Normal foreground color

com.unblu.visitor.conversationlist.toggle.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "normal" state

Normal foreground color (active)

com.unblu.visitor.conversationlist.toggle.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "normal (active)" state

"Pressed" foreground color

com.unblu.visitor.conversationlist.toggle.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.visitor.conversationlist.toggle.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.foregroundPressActive\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "visitor conversation list toggle" button in "pressed (active)" state

Grow "active" and "archived" buttons

com.unblu.visitor.conversationlist.toggle.growButtons

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

If enabled, the "active" and "archived" buttons span the width of the conversation list

Visitor admission UI

Content background color

com.unblu.visitordesk.ui.admission.contentBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of the centered content on the "Request admission", "Waiting room" and "Conversation ended" pages

com.unblu.visitordesk.ui.admission.logo

  • Type: String with allowed values:

    • account_avatar

    • brand_logo

    • brand_logo_inverse

    • named_area_avatar

    • none

  • Default: BRAND_LOGO_INVERSE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify which logo to display at the top of the "Request admission", "Waiting room", and "Conversation ended" pages. Don’t use the NAMED_AREA_AVATAR logo, as it would always fall back to the ACCOUNT_AVATAR.

Conversation date text color

com.unblu.visitordesk.ui.admission.textColorConversationInfoDate

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The text color of the conversation’s date and time

Conversation topic font color

com.unblu.visitordesk.ui.admission.textColorConversationInfoTopic

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The text color of the conversation’s topic

Custom information label text color

com.unblu.visitordesk.ui.admission.textColorCustomInfo

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The text color of the custom information label

Status information text color

com.unblu.visitordesk.ui.admission.textColorStatusInfo

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The text color of the status information label

Content title text color

com.unblu.visitordesk.ui.admission.textColorTitle

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextBody\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The text color of the title that appears on the first line of the content

Page background color

com.unblu.visitordesk.ui.admission.windowBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Background color of the "Request admission", "Waiting room", and "Conversation ended" pages

"Agent user check" service

Custom behaviour

com.unblu.visitor.agentcheck.agentPublicLinkCustomBehavior

  • Type: String with allowed values:

    • when_agent_custom_url_successful_redirect

    • when_agent_custom_url_successful_show_button

  • Default: WHEN_AGENT_CUSTOM_URL_SUCCESSFUL_REDIRECT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

This property only applies when agentPublicLinkDetectionMode=CUSTOM. Definition of behavior when custom agent detection is used and the detection shows the user is an agent. WHEN_AGENT_CUSTOM_URL_SUCCESSFUL_REDIRECT: Do an automatic redirect if the custom agent URL endpoint returned HTTP status code 200. WHEN_AGENT_CUSTOM_URL_SUCCESSFUL_SHOW_BUTTON: Show an "Are you an agent" button.

Custom URL

com.unblu.visitor.agentcheck.agentPublicLinkCustomURL

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

This property must be set when agentPublicLinkDetectionMode=CUSTOM. URL of the endpoint to check if the current user is an agent. If the endpoint returns HTTP status code 200, Unblu assumes the current user is an agent. In all other cases, it assumes the current user is a visitor.

Agent public link detection mode

com.unblu.visitor.agentcheck.agentPublicLinkDetectionMode

  • Type: String with allowed values:

    • custom

    • standard

  • Default: STANDARD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

How to detect whether the public link is opened by a visitor or an agent. When set to STANDARD, Unblu attempts to connect to the internal URL and checks if there’s an agent cookie set. When set to CUSTOM, you must configure a custom URL with agentPublicLinkCustomURL that Unblu connects to. If the URL returns HTTP status code 200, Unblu assumes the current user is an agent. If it returns HTTP status code 403 (or any other non-200 status code), it assumes the current user is a visitor.

Redirect mode for agent public links

com.unblu.visitor.agentcheck.agentPublicLinkRedirectMode

  • Type: String with allowed values:

    • never

    • when_agent_cookie_set

    • when_agent_url_reachable

  • Default: WHEN_AGENT_COOKIE_SET

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conditions for performing an automatic redirect when an agent uses a conversation’s public link. WHEN_AGENT_COOKIE_SET: Do an automatic redirect only if the agent cookie is detected. WHEN_AGENT_URL_REACHABLE: Do an automatic redirect if the agent endpoint is reachable. The endpoint is considered reachable if it returns HTTP status code 200. It is not reachable if, for instance, the DNS resolution fails, or if the CORS request is blocked. NEVER: Never do an automatic redirect.

This property only applies when agentPublicLinkDetectionMode=STANDARD.

Redirect target for agent public links

com.unblu.visitor.agentcheck.agentPublicLinkRedirectTarget

  • Type: String with allowed values:

    • agent_desk

    • single_conversation_desk

  • Default: AGENT_DESK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The target called by the automatic redirect, or when a user clicks on the "Are you an agent?" button. Only relevant when agentPublicLinkDetectionMode=STANDARD.

"Join as an agent" button display mode

com.unblu.visitor.agentcheck.joinAsAgentButtonDisplayMode

  • Type: String with allowed values:

    • always

    • never

    • when_agent_cookie_set

    • when_agent_url_reachable

  • Default: WHEN_AGENT_URL_REACHABLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conditions for displaying the "Are you an agent" button depending on the result of the potential agent check. WHEN_AGENT_COOKIE_SET: Display if the agent cookie was detected. WHEN_AGENT_URL_REACHABLE: Display if the agent endpoint is reachable. The endpoint is reachable even if it returns an error. It is not reachable if, for instance, the DNS resolution fails, or if the CORS request is blocked. ALWAYS: Always display the button. NEVER: Never display the button.

This property only applies when agentPublicLinkDetectionMode=STANDARD.

ConversationEndedComponent

customInformationAlignment

com.unblu.visitordesk.conversationended.customInformationAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

How the custom information label should be aligned on the "Conversation canceled/ended" page

showAssignee

com.unblu.visitordesk.conversationended.showAssignee

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the avatar and name of the conversation’s assigned agent on the "Conversation canceled/ended" page

showDate

com.unblu.visitordesk.conversationended.showDate

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the start date of the conversation on the "Conversation canceled/ended" page

showTopic

com.unblu.visitordesk.conversationended.showTopic

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the topic of the conversation on the "Conversation canceled/ended" page

Visitor admission request component

"Custom information" label alignment

com.unblu.visitordesk.admission.request.customInformationAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

How the custom information label should be aligned on the "Request admission" page

"Request admission" button style

com.unblu.visitordesk.admission.request.primaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: PRIMARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Require email address from anonymous visitors

com.unblu.visitordesk.admission.request.requireEmailWhenAnonymous

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether an anonymous visitor must provide an email address to request admission to a conversation

Require username from anonymous visitors

com.unblu.visitordesk.admission.request.requireUsernameWhenAnonymous

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether an anonymous visitor must provide a username to request admission to a conversation

"Cancel admission request" button style

com.unblu.visitordesk.admission.request.secondaryButtonStyle

  • Type: String with allowed values:

    • button_group

    • flat_inverse

    • flat_primary

    • flat_secondary

    • primary

    • secondary

  • Default: SECONDARY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Show assigned agent

com.unblu.visitordesk.admission.request.showAssignee

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Shows the avatar and name of the conversation’s assigned agent to a visitor before they’ve been granted permission to join

Show date

com.unblu.visitordesk.admission.request.showDate

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Shows the start date of the conversation to a visitor before they’ve been granted permission to join

Show topic

com.unblu.visitordesk.admission.request.showTopic

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Shows the topic of the conversation to visitors before they’ve been granted permission to join

Waiting room component

Alignment of custom information in "waiting room" window

com.unblu.visitordesk.waitingroom.customInformationAlignment

  • Type: String with allowed values:

    • end

    • middle

    • start

  • Default: MIDDLE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

How the custom information label should be aligned within the "Waiting room" page

Show assigned agent

com.unblu.visitordesk.waitingroom.showAssignee

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the avatar and name of the conversation’s assigned agent on the "Waiting room" page

Show date

com.unblu.visitordesk.waitingroom.showDate

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the start date of the conversation on the "Waiting room" page

Show topic

com.unblu.visitordesk.waitingroom.showTopic

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify whether to show the visitor the topic of the conversation on the "Waiting room" page

Visitor Desk configuration

Ended conversation redirect URL

com.unblu.visitor.desk.conversationClosedRedirectUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The URL that the visitor desk is redirected to when a conversation is closed. The setting can be overridden by using the query parameter "conversationEndedRedirectUrl" in the visitor desk URL.

Redirect URL failed visitor join

com.unblu.visitor.desk.conversationJoinFailedRedirectUrl

  • Type: String

  • Default: http://www.unblu.com

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Redirect URL for visitors who fail to join a conversation. The setting can be overridden using the query parameter "redirectOnFailure".

Visitor Desk conversation UI

Action bar background color

com.unblu.visitor.conversation.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.visitor.conversation.ui.actionBarDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.visitor.conversation.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.visitor.conversation.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Floating Visitor UI default width

com.unblu.visitor.conversation.ui.unbluUiDefaultWidth

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Visitor Desk collaboration space background color

com.unblu.visitor.conversation.ui.visitorDeskCollaborationSpaceBackgroundColor

  • Type: Complex color

  • Default: #525659

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Whiteboard button

"Hovered" button background color

com.unblu.whiteboard.ui.button.backgroundHover

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Style for all buttons in the whiteboard collaboration layer in the state "hovered"

"Pressed" button background color

com.unblu.whiteboard.ui.button.backgroundPress

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.secondary.backgroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Style for all buttons in the whiteboard collaboration layer in the state "pressed"

"Disabled" button foreground color

com.unblu.whiteboard.ui.button.foregroundDisabled

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral300\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Foreground color for all buttons in the whiteboard collaboration layer with the state "disabled"

Normal button foreground color

com.unblu.whiteboard.ui.button.foregroundNormal

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Style for all buttons in the whiteboard collaboration layer in the "normal" state

"Active" button foreground color

com.unblu.whiteboard.ui.button.foregroundNormalActive

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.flat.secondary.foregroundNormalActive\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Style for all buttons in the whiteboard collaboration layer in the "active" state

Whiteboard UI

Background color of whiteboard canvas

com.unblu.whiteboard.ui.canvasBackgroundColor

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable background color for exported image

com.unblu.whiteboard.ui.enabledExportBackground

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, the background of the exported image will match the canvas color, otherwise the background is transparent

Background color of whiteboard panel

com.unblu.whiteboard.ui.panelBackgroundColor

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Client-side (JavaScript) network I/O

Header type to use

com.unblu.transport.headerType

  • Type: String with allowed values:

    • http

    • virtual

  • Default: VIRTUAL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Global reconnect service

State check Interval

com.unblu.reconnect.pollOnOkayInterval

  • Type: Integer

  • Default: 5000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time waited between state checks if the state is OK or OK_OUTDATED.

Retry max wait interval

com.unblu.reconnect.retryMaxInterval

  • Type: Integer

  • Default: 30000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Max waiting time between two retries of lost server connection delivery. (If the double of the previous retry time exceeds this threshold it will be used).

StorageConfiguration

storageAccess

com.unblu.client.storage.storageAccess

  • Type: String with allowed values:

    • auto

    • local

    • xdm

  • Default: AUTO

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

configures how storage is accessed (AUTO, XDM or LOCAL)

storageBackend

com.unblu.client.storage.storageBackend

  • Type: String with allowed values:

    • auto

    • cookie

    • webstorage

  • Default: AUTO

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

configures which storage technology is used (AUTO, COOKIE or WEBSTORAGE)

Client push communication configuration

Close communication after 401 or 403 error

com.unblu.nio.closeCommunicationAfterHttpForbiddenOrUnauthorized

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If true, Unblu stops all communication with the Unblu server once a 401 or 403 is received while communicating with the Unblu server

4xx error code for NIO errors

com.unblu.nio.error4xxcode

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The effective status for NIO errors will be 400 + the value of this property)

Use WebSocket

com.unblu.nio.useWebSocket

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

WebSocket is a full duplex protocol and part of HTML5. If this configuration property is set to 'false', Unblu uses Comet, a set of techniques that allow a server to send data and notifications to a browser using long polling.

Send client base URL in a header with every request

com.unblu.transport.enableClientBaseUrlHeader

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

AuthenticationSessionConfiguration

cookieMaxAgeSeconds

com.unblu.authentication.cloud.cookieMaxAgeSeconds

  • Type: Integer

  • Default: 604800

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

maximal age in seconds of the authentication session cookie

Anonymous session redirect

Redirect URL for anonymous user "reopen conversation" requests

com.unblu.core.anonymousredirect.redirectAnonymousUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL to redirect an anonymous user to when they try to reopen their conversation (in the context of mobile push notifications)

Server date and time formatting

Reporting time-zone

com.unblu.core.server.time.timeZone

  • Type: String

  • Default: UTC

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Java time-zone ID. Refer to https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html for more information. Use TZDB region IDs such as Europe/Paris, not three-letter IDs like CET (except UTC) that don’t include daylight savings.

Visitor invitation email

Visitor invitation email BCC addresses

com.unblu.core.invitationmail.bccs

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

List of email addresses that should be added as BCC when sending visitor invitation emails

Visitor invitation mail sender address

com.unblu.core.invitationmail.sender

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for visitor invitation emails. If not set, the account or global sender email address will be used.

Conversation message log email

List of BCC addresses for "conversation message log" emails

com.unblu.conversation.messagelog.mail.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "conversation message log" emails

com.unblu.conversation.messagelog.mail.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "conversation message log" emails

com.unblu.conversation.messagelog.mail.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Tracking list recorder configuration

Geolocation information displayed

com.unblu.core.trackinglistrecorder.geoLocationParts

  • Type: List of strings

  • Default: city, country

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The geolocation information to display. The following information is available and may be used as values in the list: continent, country, state, city, userAgentTimeZone, longitude, and latitude.

Settings for the URL-based filter for embedded co-browsing content

Blacklist

com.unblu.review.server.core.player.urlfilter.black

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Deny list for the URL-based filter of embedded co-browsing content

Enable URL filter

com.unblu.review.server.core.player.urlfilter.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable URL-based filtering of embedded co-browsing content

URL filter title

com.unblu.review.server.core.player.urlfilter.filterTitle

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Title of the URL-based filter for embedded co-browsing content

Embedded Co-Browsing filter URL

com.unblu.review.server.core.player.urlfilter.filterUrl

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Settings for the URL-based filter for embedded co-browsing content: filter URL

Embedded Co-Browsing filter window dimension

com.unblu.review.server.core.player.urlfilter.filterWindowDimension

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Settings for the URL-based filter for embedded co-browsing content: filter window dimension

Embedded Co-Browsing filter order

com.unblu.review.server.core.player.urlfilter.order

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: BLACK_WHITE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Settings for the URL-based filter for embedded co-browsing content: Order

Embedded Co-Browsing filter whitelisting

com.unblu.review.server.core.player.urlfilter.white

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Allow list for the URL-based filter of embedded co-browsing content

AgentCookieService

Base URL for agent public link

com.unblu.visitor.agentcheck.agentPublicLinkBaseURL

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

The URL is used for the agent cookie URL as well as for the URL in the "Join as an agent" button and the automatic redirect. If it isn’t set, the standard internal base URL is used.

FileInterceptorScanningConfiguration

File upload approval request timeout

com.unblu.fileuploadinterceptor.scanning.requestTimeout

  • Type: Integer

  • Default: 60000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Minimum time (in milliseconds) the Collaboration Server waits for all file interceptors to approve or reject a file. If the timeout is reached before the entire scanning process is complete, the token is invalidated and the file upload is rejected. The maximum time is calculated as this timeout plus the cleanupInterval time.

File scanning timeout / cleanup job interval

com.unblu.fileuploadinterceptor.scanning.timeoutJobInterval

  • Type: Integer

  • Default: 5000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Cleanup interval (in milliseconds) for the file scanning request log

Participation IP logging

User IP logging

com.unblu.cloud.server.core.ParticipationIPLogging.IPLogging

  • Type: String with allowed values:

    • hash

    • ip

    • ip_hash

    • none

  • Default: HASH

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Choose what to log with regard to the user’s IP. HASH is a one-way, irreversible encryption of the IP address which you may choose to log instead of IPs for privacy reasons.

"Password generated" email

BCC addresses for "Password generated" emails

com.unblu.core.server.core.mail.GeneratedPasswordMail.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

List of BCC addresses for "Password generated" emails

Reply-to address for "password generated" emails

com.unblu.core.server.core.mail.GeneratedPasswordMail.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

If not set, the account or global reply-to address is used

Sender address for "password generated" emails

com.unblu.core.server.core.mail.GeneratedPasswordMail.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

If not set, the account or global sender address is used

"Password reset via link" email

List of BCC addresses for "password reset via link" emails

com.unblu.core.server.core.mail.PasswordResetLinkMail.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "password reset via link" emails

com.unblu.core.server.core.mail.PasswordResetLinkMail.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

If not set, the account or global reply-to email address is used

Sender address for "password reset via link" emails

com.unblu.core.server.core.mail.PasswordResetLinkMail.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

If not set, the account or global sender email address is used

User mail service

Send generated password by email

com.unblu.core.server.core.mail.UserMailService.sendGeneratedPasswordsViaMail

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Send email to user if their password has been reset to a generated password

Default password policy

Password digit policy

com.unblu.password.policy.defaultpolicy.digitCharacterGroup

  • Type: String

  • Default: [0-9]

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Digits permissible in passwords

Password digits policy

com.unblu.password.policy.defaultpolicy.digitsPolicy

  • Type: String with allowed values:

    • accepted

    • invalid

    • required

  • Default: REQUIRED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Policy regarding digits in the password

Password characters policy

com.unblu.password.policy.defaultpolicy.letterCharacterGroup

  • Type: String

  • Default: [a-z]

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Characters permissible in passwords

Password letters policy

com.unblu.password.policy.defaultpolicy.lettersPolicy

  • Type: String with allowed values:

    • accepted

    • invalid

    • required

  • Default: ACCEPTED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Policy regarding letters in the password

Password lower case character policy

com.unblu.password.policy.defaultpolicy.lowerCaseCharacterPolicy

  • Type: String with allowed values:

    • accepted

    • invalid

    • required

  • Default: REQUIRED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Policy regarding lower case characters in the password

Password maximum length policy

com.unblu.password.policy.defaultpolicy.maxLength

  • Type: Integer

  • Default: 250

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum length of a password (default: 250 characters)

Password minimum length policy

com.unblu.password.policy.defaultpolicy.minLength

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The minimum length of a password

Password acceptable special characters

com.unblu.password.policy.defaultpolicy.specialCharacterGroup

  • Type: String

  • Default: [?!+\-_:;,\\.()\{\}\[\]|^~/\\&%*'"@#$£]

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Acceptable special characters in a password

Password special characters policy

com.unblu.password.policy.defaultpolicy.specialCharacterPolicy

  • Type: String with allowed values:

    • accepted

    • invalid

    • required

  • Default: ACCEPTED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Policy regarding special characters in the password

Password upper case policy

com.unblu.password.policy.defaultpolicy.upperCaseCharacterPolicy

  • Type: String with allowed values:

    • accepted

    • invalid

    • required

  • Default: REQUIRED

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Policy regarding upper case characters in the password

PublishSubscribeConfiguration

useKafka

com.unblu.pubsub.useKafka

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

whether or not kafka should be used (or if embedded local pubsub should be used)

DataSetupConfiguration

createSuperAdmin

com.unblu.storage.createSuperAdmin

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Should a super admin user be generated

domains

com.unblu.storage.domains

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Static list of domains (separator = ,)

resetSuperAdmin

com.unblu.storage.resetSuperAdmin

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Should the super admin user be resetted

superAdminPassword

com.unblu.storage.superAdminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Password for the admin user to be generated

superAdminUsername

com.unblu.storage.superAdminUsername

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Username for the admin user to be generated

users

com.unblu.storage.users

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Static list of users. Format for a single user: <gender>;<userName>;<firstName>;<lastName>;<password>;<role>

DeprecatedPropertiesV6

zookeeperSyncTimeMs

com.unblu.kafka.server.zookeeperSyncTimeMs

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

Properties deprecated in Unblu 7

Enable scheduled conversations

com.unblu.conversation.feature.scheduledConversationEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

DEPRECATED - no longer used

Auto-end on PIN dialog cancellation

com.unblu.conversation.lifecycle.autoEndOnPinDialogCancel

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

DEPRECATED - no longer used

Additional JavaScript for player

com.unblu.core.server.visual.additionalPlayerJavascript

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

DEPRECATED - no longer used

Additional deferred JavaScript for player

com.unblu.core.server.visual.additionalPlayerJavascriptDeferred

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

DEPRECATED - no longer used

String literal quote

com.unblu.server.css.stringLiteralQuote

  • Type: String

  • Default: "

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

DEPRECATED - no longer used

Trusted CSS filter comments

com.unblu.server.css.trustedCSSFilterComments

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

DEPRECATED - no longer used

trustedCSSAllowUnknownIEFilters

com.unblu.server.security.trustedCSSAllowUnknownIEFilters

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

DEPRECATED - no longer used

nodeStoreExpirationTime

com.unblu.server.storage.blob.nodeStoreExpirationTime

  • Type: Integer

  • Default: 7200

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

nodeStoreType

com.unblu.server.storage.blob.nodeStoreType

  • Type: String with allowed values:

    • file

    • memory

  • Default: Memory

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

auditLogRetention

com.unblu.storage.database.audit.auditLogRetention

  • Type: Integer

  • Default: 365

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

DEPRECATED - no longer used

sharedPool

com.unblu.storage.database.sharedPool

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

EntityConfigImport

preventStartOnImportError

com.unblu.entityImport.preventStartOnImportError

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Ensure that the server does not start when there is an error with the entity import

source

com.unblu.entityImport.source

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Path pointing to either a JSON file, ZIP file or a folder. If path, it expects a ZIP or folder exported from an Unblu system (utransfer export format).

"New assignment request" notification email

Enable "new assignment request" email notifications

com.unblu.core.mail_notification.newAssignmentRequestNotification.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether "new assignment request" email notifications are enabled

"New assignment request" notification email recipients

com.unblu.core.mail_notification.newAssignmentRequestNotification.recipients

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

List of email addresses to receive "new assignment request" email notifications

"New assignment request" email notification delay (in ms)

com.unblu.core.mail_notification.newAssignmentRequestNotification.timeOut

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time in milliseconds that agents have to answer an assignment request before the email notification about a new pending request is sent out. If no agents are available to deal with the request, the notification email is sent immediately.

"New assignment request" notification email

List of BCC addresses for "new assignment request" notification emails

com.unblu.core.mail_notification.newAssignmentRequestNotification.mail.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "new assignment request" notification emails

com.unblu.core.mail_notification.newAssignmentRequestNotification.mail.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "new assignment request" notification emails

com.unblu.core.mail_notification.newAssignmentRequestNotification.mail.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Mail push notification configuration

Enable "agent invitation" and "agent forwarding" push notification emails

com.unblu.core.push_notification.mail.enableEmailAgentInvitationPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "conversation agent invitation" and "conversation agent forwarding" push notifications

Enable agent email notifications for new messages

com.unblu.core.push_notification.mail.enableEmailAgentNewMessagesPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailNewMessagesPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable anonymous visitor email notifications for new messages

com.unblu.core.push_notification.mail.enableEmailAnonymousVisitorNewMessagesPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailNewMessagesPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable authenticated visitor email notifications for new messages

com.unblu.core.push_notification.mail.enableEmailAuthenticatedVisitorNewMessagesPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailNewMessagesPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable "deputy delegation" push notification emails

com.unblu.core.push_notification.mail.enableEmailDeputyDelegationPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "deputy delegation" push notifications

Enable "inbound request" push notifications by email

com.unblu.core.push_notification.mail.enableEmailInboundRequestPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "inbound request" push notifications

Enable email notification for incoming calls

com.unblu.core.push_notification.mail.enableEmailIncomingCallPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "incoming call" push notifications

Enable "missed call" push notification emails

com.unblu.core.push_notification.mail.enableEmailMissedCallPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "missed call" push notifications

Enable push notification via email for new messages

com.unblu.core.push_notification.mail.enableEmailNewMessagesPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "new messages" push notifications

Enable push notifications via email

com.unblu.core.push_notification.mail.enableEmailPushNotification

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable email push notifications

Enable "team invitation" and "team forwarding" push notifications by email

com.unblu.core.push_notification.mail.enableEmailTeamInvitationPushNotification

Only visible if: com.unblu.core.push_notification.mail.enableEmailPushNotification=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Enable the email option for "conversation team invitation" and "conversation team forwarding" push notifications

Anonymous visitor "new message" notification email

List of BCC addresses for anonymous visitors' "new messages" notification emails

com.unblu.core.push_notification.mail.messages.anonymous.bccEmails

Only visible if: com.unblu.core.push_notification.mail.enableEmailAnonymousVisitorNewMessagesPushNotification=true

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for anonymous visitors' "new message" notification emails

com.unblu.core.push_notification.mail.messages.anonymous.replyToEmail

Only visible if: com.unblu.core.push_notification.mail.enableEmailAnonymousVisitorNewMessagesPushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for anonymous visitors' "new message" notification emails

com.unblu.core.push_notification.mail.messages.anonymous.senderEmail

Only visible if: com.unblu.core.push_notification.mail.enableEmailAnonymousVisitorNewMessagesPushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Authenticated visitor "new message" notification email

List of BCC addresses for authenticated visitor "new message" notification emails

com.unblu.core.push_notification.mail.messages.authenticated.bccEmails

Only visible if: com.unblu.core.push_notification.mail.enableEmailAuthenticatedVisitorNewMessagesPushNotification=true

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for authenticated visitor "new message" notification emails

com.unblu.core.push_notification.mail.messages.authenticated.replyToEmail

Only visible if: com.unblu.core.push_notification.mail.enableEmailAuthenticatedVisitorNewMessagesPushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for authenticated visitor "new message" notification emails

com.unblu.core.push_notification.mail.messages.authenticated.senderEmail

Only visible if: com.unblu.core.push_notification.mail.enableEmailAuthenticatedVisitorNewMessagesPushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Agent forwarding notification email

List of BCC addresses for "agent forwarding" notification emails

com.unblu.core.push_notification.mail.forwarding.agent.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "agent forwarding" notification emails

com.unblu.core.push_notification.mail.forwarding.agent.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "agent forwarding" notification email

com.unblu.core.push_notification.mail.forwarding.agent.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Agent invitation notification email

List of BCC addresses for "agent invitation" notification emails

com.unblu.core.push_notification.mail.invitation.agent.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "agent invitation" notification emails

com.unblu.core.push_notification.mail.invitation.agent.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "agent invitation" notification emails

com.unblu.core.push_notification.mail.invitation.agent.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Team forwarding notification email

List of BCC addresses for "team forwarding" notification emails

com.unblu.core.push_notification.mail.forwarding.team.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "team forwarding" notification emails

com.unblu.core.push_notification.mail.forwarding.team.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "team forwarding" notification emails

com.unblu.core.push_notification.mail.forwarding.team.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Team invitation notification email

List of BCC addresses for "conversation team invitation" notification emails

com.unblu.core.push_notification.mail.invitation.team.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "team invitation" notification emails

com.unblu.core.push_notification.mail.invitation.team.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "team invitation" notification emails

com.unblu.core.push_notification.mail.invitation.team.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Deputy delegation notification email

List of BCC addresses for "deputy delegation" notification emails

com.unblu.core.push_notification.mail.deputy-delegation.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "deputy delegation" notification emails

com.unblu.core.push_notification.mail.deputy-delegation.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "deputy delegation" notification emails

com.unblu.core.push_notification.mail.deputy-delegation.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Inbound request notification email

List of BCC addresses for "inbound request" notification emails

com.unblu.core.push_notification.mail.inbound-request.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "inbound request" notification emails

com.unblu.core.push_notification.mail.inbound-request.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "inbound request" notification emails

com.unblu.core.push_notification.mail.inbound-request.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Incoming call notification email

List of BCC addresses for "Incoming call" notification emails

com.unblu.core.push_notification.mail.call.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "incoming call" notification emails

com.unblu.core.push_notification.mail.call.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "incoming call" notification emails

com.unblu.core.push_notification.mail.call.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Missed call notification emails

List of BCC addresses for "Missed call" notification emails

com.unblu.core.push_notification.mail.call.missed.bccEmails

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Reply-to address for "missed call" notification emails

com.unblu.core.push_notification.mail.call.missed.replyToEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

Sender address for "missed call" notification emails

com.unblu.core.push_notification.mail.call.missed.senderEmail

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: .@.

AuditStorageConfiguration

auditLogRetentionCheckInterval

com.unblu.storage.database.audit.auditLogRetentionCheckInterval

  • Type: Integer

  • Default: 360

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The interval, in seconds, at which the retention period for audit log data is checked. Audit log data for which the retention period has been exceeded will be deleted at this interval.

Maximum deleted audit log entries

com.unblu.storage.database.audit.auditLogRetentionMaxDeletionChunkSize

  • Type: Integer

  • Default: 1000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of audit log entities that should be deleted per account iteration each time the retention period for audit log data is checked

Maximum number of deleted audit log entries

com.unblu.storage.database.audit.auditLogRetentionMaxNumberOfDeleted

  • Type: Integer

  • Default: 1000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of audit log entities that should be deleted each time the retention period for audit log data is checked

automaticAuditLogDeletion

com.unblu.storage.database.audit.automaticAuditLogDeletion

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Turns on and off the automatic deletion of audit log data on retention based deletion

persistRetries

com.unblu.storage.database.audit.persistRetries

  • Type: Integer

  • Default: 5

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The number of times persisting an audit log entry is retried in case of an error

persistRetriesDelay

com.unblu.storage.database.audit.persistRetriesDelay

  • Type: Integer

  • Default: 30

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Delay, in seconds, between retries to persist an audit log entry in case of an error

BlobStoreFactory

deleteAbandonedRemoteBlobs

com.unblu.server.storage.blob.deleteAbandonedRemoteBlobs

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If true, a Liquibase task removes remote blobs that aren’t present in the database. The task is only run once, it isn’t repeated.

Persistent store type

com.unblu.server.storage.blob.persistentStoreType

  • Type: String with allowed values:

    • azure

    • database

    • gcs

    • s3

  • Default: Database

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The type of persistent blob store. The supported types are DATABASE, S3, AZURE and GCS.

QuarantineBlobStoreFactory

Quarantine persistent store type

com.unblu.server.storage.blob.quarantine.persistentStoreType

  • Type: String with allowed values:

    • azure

    • database

    • gcs

    • s3

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The type of persistent blob store used for quarantined files. The supported types are DATABASE, S3, AZURE and GCS.

AzureBlobStore

The Azure authentication type used

com.unblu.server.storage.blob.store.azure.authenticationType

  • Type: String with allowed values:

    • connection_string

    • spn

  • Default: CONNECTION_STRING

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Client ID for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.clientId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Client secret for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.clientSecret

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Azure container name

com.unblu.server.storage.blob.store.azure.containerName

  • Type: String

  • Default: unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The container is created if it doesn’t exist

Create blob container if it doesn’t exist

com.unblu.server.storage.blob.store.azure.createContainerIfNotExists

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If enabled, Unblu checks during start-up whether a blob container exists in the Azure Storage account. If no blob container exists it creates one.

Environment used for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.environment

  • Type: String with allowed values:

    • azure

    • azure_china

    • azure_germany

    • azure_us_government

  • Default: AZURE

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Prefix for blob names in Azure container

com.unblu.server.storage.blob.store.azure.folder

  • Type: String

  • Default: blobs

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Blob names have the format <prefix>/<blob ID>.

Load data from database if available

com.unblu.server.storage.blob.store.azure.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring Unblu from database to Azure blob store, the database copy is used instead of fetching it from Azure

Azure SPN authentication thread pool size

com.unblu.server.storage.blob.store.azure.spnAuthenticationThreadPoolSize

  • Type: Integer

  • Default: 1

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Storage account name for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.storageAccountName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Connection string for Azure Storage account

com.unblu.server.storage.blob.store.azure.storageConnectionString

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The connection string may be in the Shared Key authorization format or the Shared Access Signature (SAS) format for use with SAS tokens. Example of a connection string for Shared Key authorization: DefaultEndpointsProtocol=http;AccountName=your_storage_account_name;AccountKey=your_storage_account_key

Storage endpoint for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.storageEndpoint

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Stream write size during upload to Azure

com.unblu.server.storage.blob.store.azure.streamWriteSize

  • Type: Integer

  • Default: 40960

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

During file upload, the data is flushed in Azure Storage every n bytes as specified in this property, in order to be able to recover the data if the upload doesn’t finish. The value can be set from 16kB to 100MB, but a high value prevents restoring parts of an upload if it’s interrupted.

Tenant ID for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.tenantId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

AzureQuarantineBlobStore

The Azure authentication type used

com.unblu.server.storage.blob.store.azure.quarantine.authenticationType

  • Type: String with allowed values:

    • connection_string

    • spn

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Client ID for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.clientId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Client secret for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.clientSecret

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Azure container name

com.unblu.server.storage.blob.store.azure.quarantine.containerName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The container is created if it doesn’t exist

Create blob container if it doesn’t exist

com.unblu.server.storage.blob.store.azure.quarantine.createContainerIfNotExists

  • Type: Boolean

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If enabled, Unblu checks during start-up whether a blob container exists in the Azure Storage account. If no blob container exists it creates one.

Environment used for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.environment

  • Type: String with allowed values:

    • azure

    • azure_china

    • azure_germany

    • azure_us_government

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Prefix for blob names in Azure container

com.unblu.server.storage.blob.store.azure.quarantine.folder

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Blob names have the format <prefix>/<blob ID>.

Load data from database if available

com.unblu.server.storage.blob.store.azure.quarantine.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring Unblu from database to Azure blob store, the database copy is used instead of fetching it from Azure

Azure SPN authentication thread pool size

com.unblu.server.storage.blob.store.azure.quarantine.spnAuthenticationThreadPoolSize

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Storage account name for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.storageAccountName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Connection string for Azure Storage account

com.unblu.server.storage.blob.store.azure.quarantine.storageConnectionString

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The connection string may be in the Shared Key authorization format or the Shared Access Signature (SAS) format for use with SAS tokens. Example of a connection string for Shared Key authorization: DefaultEndpointsProtocol=http;AccountName=your_storage_account_name;AccountKey=your_storage_account_key

Storage endpoint for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.storageEndpoint

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Stream write size during upload to Azure

com.unblu.server.storage.blob.store.azure.quarantine.streamWriteSize

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

During file upload, the data is flushed in Azure Storage every n bytes as specified in this property, in order to be able to recover the data if the upload doesn’t finish. The value can be set from 16kB to 100MB, but a high value prevents restoring parts of an upload if it’s interrupted.

Tenant ID for Azure SPN authentication

com.unblu.server.storage.blob.store.azure.quarantine.tenantId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

GcsBlobStore

GCS bucket name

com.unblu.server.storage.blob.store.gcs.bucketName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Folder in GCS bucket

com.unblu.server.storage.blob.store.gcs.folder

  • Type: String

  • Default: blobs

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

GCS service account key

com.unblu.server.storage.blob.store.gcs.gcsServiceAccountKey

  • Type: Multiline secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

the key must be in JSON format. If not configured Application Default Credentials (ADC) are used.

Load data from database if available

com.unblu.server.storage.blob.store.gcs.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring from database to GCS blob store, it is used instead of fetching it from GCS

Store internal state every n bytes

com.unblu.server.storage.blob.store.gcs.storeInternalStateEveryBytes

  • Type: Integer

  • Default: 40960

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The number of bytes after which recorded data is backed up to the Unblu database during recording. Only change the value after consulting Unblu.

GcsQuarantineBlobStore

GCS bucket name

com.unblu.server.storage.blob.store.gcs.quarantine.bucketName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Folder in GCS bucket

com.unblu.server.storage.blob.store.gcs.quarantine.folder

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

GCS service account key

com.unblu.server.storage.blob.store.gcs.quarantine.gcsServiceAccountKey

  • Type: Multiline secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

the key must be in JSON format. If not configured Application Default Credentials (ADC) are used.

Load data from database if available

com.unblu.server.storage.blob.store.gcs.quarantine.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring from database to GCS blob store, it is used instead of fetching it from GCS

Store internal state every n bytes

com.unblu.server.storage.blob.store.gcs.quarantine.storeInternalStateEveryBytes

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The number of bytes after which recorded data is backed up to the Unblu database during recording. Only change the value after consulting Unblu.

PendingBlobCleanup

checkInterval

com.unblu.server.storage.blob.pendingBlobCleanup.checkInterval

  • Type: Integer

  • Default: 5000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in milliseconds, between runs of the cleanup job for blobs in the PENDING state.

pendingBlobTimeout

com.unblu.server.storage.blob.pendingBlobCleanup.pendingBlobTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in milliseconds, since the last change to a blob in the PENDING state for that blob to be considered abandoned. The time of the last change to a blob is determined based on its modification timestamp.

S3BlobStore

Amazon S3 bucket name

com.unblu.server.storage.blob.store.s3.bucketName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Check upload integrity

com.unblu.server.storage.blob.store.s3.checkUploadIntegrity

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Amazon S3 endpoint

com.unblu.server.storage.blob.store.s3.endpoint

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Required to configure third-party S3 compliant services

Folder in Amazon S3 bucket

com.unblu.server.storage.blob.store.s3.folder

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Load data from database if available

com.unblu.server.storage.blob.store.s3.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring from database to S3 blob store, it is used instead of fetching it from S3.

Store internal state every n bytes

com.unblu.server.storage.blob.store.s3.storeInternalStateEveryBytes

  • Type: Integer

  • Default: 40960

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The number of bytes after which recorded data is backed up to the Unblu database during recording

S3QuarantineBlobStore

Amazon S3 bucket name

com.unblu.server.storage.blob.store.s3.quarantine.bucketName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Check upload integrity

com.unblu.server.storage.blob.store.s3.quarantine.checkUploadIntegrity

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Amazon S3 endpoint

com.unblu.server.storage.blob.store.s3.quarantine.endpoint

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Required to configure third-party S3 compliant services

Folder in Amazon S3 bucket

com.unblu.server.storage.blob.store.s3.quarantine.folder

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Load data from database if available

com.unblu.server.storage.blob.store.s3.quarantine.loadDataFromDatabaseIfAvailable

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If the blob data is present in the database, for example after reconfiguring from database to S3 blob store, it is used instead of fetching it from S3.

Store internal state every n bytes

com.unblu.server.storage.blob.store.s3.quarantine.storeInternalStateEveryBytes

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The number of bytes after which recorded data is backed up to the Unblu database during recording

DeprecatedPropertiesV7_1

adminDatasourceFactory

com.unblu.storage.database.audit.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.audit.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.audit.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.audit.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.audit.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.audit.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.audit.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.audit.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.audit.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.audit.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.audit.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

EclipseLink platform class

poolConnectionTimeout

com.unblu.storage.database.audit.poolConnectionTimeout

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolInitial

com.unblu.storage.database.audit.poolInitial

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.audit.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.audit.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.audit.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.audit.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.audit.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

DeprecatedPropertiesV7_2

adminDatasourceFactory

com.unblu.storage.database.weho.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.weho.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.weho.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.weho.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.weho.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.weho.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.weho.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.weho.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.weho.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.weho.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.weho.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolConnectionTimeout

com.unblu.storage.database.weho.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.weho.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.weho.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.weho.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.weho.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.weho.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

DeprecatedPropertiesV7_3

adminDatasourceFactory

com.unblu.storage.database.umm.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.umm.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.umm.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.umm.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.umm.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.umm.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.umm.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.umm.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.umm.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.umm.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.umm.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolConnectionTimeout

com.unblu.storage.database.umm.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.umm.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.umm.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.umm.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.umm.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.umm.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

DeprecatedPropertiesV7_4

adminDatasourceFactory

com.unblu.storage.database.main.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.main.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.main.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.main.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.main.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.main.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.main.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.main.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.main.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.main.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.main.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolConnectionTimeout

com.unblu.storage.database.main.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.main.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.main.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.main.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.main.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.main.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

DeprecatedPropertiesV7_5

adminDatasourceFactory

com.unblu.storage.database.live.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.live.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.live.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.live.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.live.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.live.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.live.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.live.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.live.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.live.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.live.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolConnectionTimeout

com.unblu.storage.database.live.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.live.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.live.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.live.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.live.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.live.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

DeprecatedPropertiesV7_6

adminDatasourceFactory

com.unblu.storage.database.auth.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminDatasourceName

com.unblu.storage.database.auth.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminJdbcProperties

com.unblu.storage.database.auth.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminPassword

com.unblu.storage.database.auth.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

adminUser

com.unblu.storage.database.auth.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceFactory

com.unblu.storage.database.auth.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

datasourceName

com.unblu.storage.database.auth.datasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

driver

com.unblu.storage.database.auth.driver

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

jdbcProperties

com.unblu.storage.database.auth.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

password

com.unblu.storage.database.auth.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

platform

com.unblu.storage.database.auth.platform

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolConnectionTimeout

com.unblu.storage.database.auth.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMax

com.unblu.storage.database.auth.poolMax

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

poolMinIdle

com.unblu.storage.database.auth.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

schema

com.unblu.storage.database.auth.schema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

url

com.unblu.storage.database.auth.url

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

user

com.unblu.storage.database.auth.user

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DEPRECATED - no longer used

FileDataStoreBlobDeletionRequestJob

batchSize

com.unblu.server.storage.blob.deletion.batchSize

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum number of external blobs that are deleted when this job is executed.

checkInterval

com.unblu.server.storage.blob.deletion.checkInterval

  • Type: Integer

  • Default: 300000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in milliseconds, between runs of the job that deletes external blobs.

maxRetries

com.unblu.server.storage.blob.deletion.maxRetries

  • Type: Integer

  • Default: 5

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum number of times the job tries to delete an external blob.

StorageConfiguration

adminDatasourceFactory

com.unblu.storage.database.adminDatasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Which datasource to use with additional DB rights. Values: HIKARI (default): use other config properties to configure datasource, USE_PROVIDED: Allows to define an adminDatasourceName to be retrieved from JNDI

adminDatasourceName

com.unblu.storage.database.adminDatasourceName

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

JNDI data source name with additional DB rights. Full name is java:comp/env/<datasourceName>. Default: java:comp/env/jdbc/unblu_admin. Only active when datasourceFactory=USE_PROVIDED is used. Falls back to datasourceName if not specified

adminJdbcProperties

com.unblu.storage.database.adminJdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Jdbc Properties for admin connection

adminPassword

com.unblu.storage.database.adminPassword

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database admin password (for connection)

adminUser

com.unblu.storage.database.adminUser

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database admin user (for connection)

azureAuthenticationTokenTTLGracePeriodRatio

com.unblu.storage.database.azureAuthenticationTokenTTLGracePeriodRatio

  • Type: Float

  • Default: 0.8

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The Azure database authentication token is rotated when the expired fraction of its lease is greater than this value. For example, with a value of 0.8, the credentials are rotated when 80% of their time-to-live (TTL) has passed.

Client ID for Azure SPN authentication

com.unblu.storage.database.azureClientId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Client secret for Azure SPN authentication

com.unblu.storage.database.azureClientSecret

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Environment used for Azure SPN authentication

com.unblu.storage.database.azureEnvironment

  • Type: String with allowed values:

    • azure

    • azure_china

    • azure_germany

    • azure_us_government

  • Default: AZURE

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Tenant ID for Azure SPN authentication

com.unblu.storage.database.azureTenantId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

datasourceFactory

com.unblu.storage.database.datasourceFactory

  • Type: String with allowed values:

    • hikari

    • use_provided

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Which datasource to use. Values: USE_PROVIDED: Allows to define a datasourceName to be retrieved from JNDI, HIKARI: (default) Hikari connection-pool(see https://github.com/brettwooldridge/HikariCP)

datasourceName

com.unblu.storage.database.datasourceName

  • Type: String

  • Default: jdbc/unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

JNDI data source name. Full name is java:comp/env/<datasourceName>. Default: java:comp/env/jdbc/unblu. Only active when datasourceFactory=USE_PROVIDED is used.

dbSetupEnabled

com.unblu.storage.database.dbSetupEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Should the database setup procedure run or not (at server-startup) ATTENTION: The DB must be on the same state (version) then the unblu-server!

driver

com.unblu.storage.database.driver

  • Type: String

  • Default: org.h2.Driver

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Jdbc Driver class

jdbcProperties

com.unblu.storage.database.jdbcProperties

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Jdbc Properties

liquibaseSchema

com.unblu.storage.database.liquibaseSchema

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database schema for Liquibase tables

password

com.unblu.storage.database.password

  • Type: Secret

  • Default: secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database password (for connection)

platform

com.unblu.storage.database.platform

  • Type: String

  • Default: Auto

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

EclipseLink platform class

poolConnectionTimeout

com.unblu.storage.database.poolConnectionTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout in milliseconds to wait for a connection from the pool. Only applies to HikariCP!

poolMax

com.unblu.storage.database.poolMax

  • Type: String

  • Default: 50

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Specifies the maximum number of connection in the pool

poolMinIdle

com.unblu.storage.database.poolMinIdle

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum number of idle connections that HikariCP tries to maintain in the pool. Defaults to poolMax when not specified. Only applies to HikariCP!

schema

com.unblu.storage.database.schema

  • Type: String

  • Default: unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

DatabaseSchema

url

com.unblu.storage.database.url

  • Type: String

  • Default: jdbc:h2:mem:unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database url

user

com.unblu.storage.database.user

  • Type: String

  • Default: unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Database user (for connection)

Resource URI transformer settings

uriTransformPattern

com.unblu.visual.resource.recorder.uriTransformPattern

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern for uri transformation

uriTransformReplacement

com.unblu.visual.resource.recorder.uriTransformReplacement

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Replacement for uri transformation

Request flow for resources in embedded co-browsing (cloud)

com.unblu.visual.resource.recorder.uriTransformTarget

  • Type: String with allowed values:

    • proxy

    • unblu

  • Default: UNBLU

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Target of the URI transformation (UNBLU, PROXY) to determine how resources are being requested in embedded co-browsing sessions

black

com.unblu.visual.resource.recorder.urlvalidation.black

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list for url validation (block/allow urls)

order

com.unblu.visual.resource.recorder.urlvalidation.order

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: BLACK_WHITE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list for url validation (block/allow urls)

white

com.unblu.visual.resource.recorder.urlvalidation.white

  • Type: List of strings

  • Default: .*

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list for url validation (block/allow urls)

SecurityProcessingConfig

dataUrlTransformationStrategy

com.unblu.server.security.dataUrlTransformationStrategy

  • Type: String with allowed values:

    • allow

    • block

    • sanitize

  • Default: ALLOW

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Stragetgy for data urls.

eventTypeAttributeFilter

com.unblu.server.security.eventTypeAttributeFilter

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Whether element attributes starting with on…​ should always be dropped

filterjavascripturls

com.unblu.server.security.filterjavascripturls

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Whether or not java script urls should be filterd

invalidnodeAction

com.unblu.server.security.invalidnodeAction

  • Type: String with allowed values:

    • abort_session

    • drop_node

    • replace_node

  • Default: DROP_NODE

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Action for invalid nodes

tagfilter

com.unblu.server.security.tagfilter

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Whether or not tags are filtered on the server

strategy

com.unblu.server.security.tagfilter.strategy

  • Type: String

  • Default: blacklist

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Possible values are 'blacklist' or 'whitelist'. Blacklist means; elements known as dangerous (script tag, on* attributes etc) are dealt with - unknown elements can pass. Whitelist means; only elements and attributes known are allowed through.

trustedCSSAllowUnknownFunctions

com.unblu.server.security.trustedCSSAllowUnknownFunctions

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Whether or not functions should be allowed inside css filters

trustedCSSDataUrlTransformationStrategy

com.unblu.server.security.trustedCSSDataUrlTransformationStrategy

  • Type: String with allowed values:

    • allow

    • block

    • sanitize

  • Default: ALLOW

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Strategy for data urls inside trusted css filters

Resource CSS processor

Embedded co-browsing: add charset

com.unblu.server.css.addCharset

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to add a charset entry when generating CSS

disableTransformationProcess

com.unblu.server.css.disableTransformationProcess

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether not to run the CSS transformation process

Escape non-latin1 characters in embedded co-browsing

com.unblu.server.css.enableEscapeNonLatin1

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to escape characters not part of ISO-8859-1 during embedded co-browsing

Enable multiline CSS output

com.unblu.server.css.enableMultilineOutput

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether CSS should be generated with multiple lines

Embedded Co-Browsing pretty print

com.unblu.server.css.enablePrettyPrint

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether CSS files should be pretty-printed

Safe CSS filters

com.unblu.server.css.safeFilters

  • Type: List of strings

  • Default: blur,brightness,contrast,drop-shadow,grayscale,hue-rotate,invert,opacity,saturate,sepia

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A list of CSS filter functions (in particular those not referencing resources) that are considered safe and will be passed on from the visitor to the agent. Any function style property in this list will pass the Unblu CSS parser without further tests. This is only safe if the function has no parameters that refer to external resources. You should only change this list after careful consideration.

Safe CSS functions

com.unblu.server.css.safeFunctions

  • Type: List of strings

  • Default: local,attr,var,env,constant,counter,counters,calc,clamp,max,min,abs,acos,asin,atan,atan2,cos,exp,hypot,log,mod,pow,rem,round,sign,sin,sqrt,tan,stylistic,styleset,character-variant,swash,ornaments,annotation,image,image-set,linear-gradient,radial-gradient,conic-gradient,repeating-linear-gradient,repeating-radial-gradient,repeat-conic-gradiant,color,color-mix,color-contrast,device-cmyk,hsl,hsla,hwb,lab,lch,rgb,rgba,inset,circle,ellipse,polygon,rect,cubic-bezier,steps,frames,fit-content,minmax,repeat,matrix,translate,translateX,translateY,scale,scaleX,scaleY,rotate,skew,skewX,skewY,matrix3d,translate3d,translateZ,scale3d,scaleZ,rotate3d,rotateX,rotateY,rotateZ,perspective

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A list of CSS value functions (in particular those not referencing resources) that are considered safe and will be passed on one-to-one from visitor to agent. Any function style property in this list will pass the Unblu CSS parser without further tests. This is only safe if the function has no parameters referring external resources. Only change this list after careful consideration.

ResourceHistory

enableRedirectSupport

com.unblu.visual.resourcehistory.enableRedirectSupport

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether the resource history should track redirects (limited functionality)

enabled

com.unblu.visual.resourcehistory.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether the resource history should be enabled

greedyResourceFetchingCSS

com.unblu.visual.resourcehistory.greedyResourceFetchingCSS

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether missing resources should be fetched greedily if they are referenced from CSS

greedyResourceFetchingHTML

com.unblu.visual.resourcehistory.greedyResourceFetchingHTML

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether missing resources should be fetched greedily if they are referenced from HTML

greedyResourceFetchingSVG

com.unblu.visual.resourcehistory.greedyResourceFetchingSVG

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether missing resources should be fetched greedily if they are referenced from SVG

trackMissingResources

com.unblu.visual.resourcehistory.trackMissingResources

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether missing resources should be tracked

usePathAsIdentifier

com.unblu.visual.resourcehistory.usePathAsIdentifier

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Experimental support for using paths as resource identifiers instead of URLs

useQueryStringCacheInvalidation

com.unblu.visual.resourcehistory.useQueryStringCacheInvalidation

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether a cache-avoiding query string should be added when fetching missing resources

ResourcePathTranslatorExternalResources

blackList

com.unblu.visual.resourcehistory.externalResources.blackList

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

order

com.unblu.visual.resourcehistory.externalResources.order

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: WHITE_BLACK

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

whiteList

com.unblu.visual.resourcehistory.externalResources.whiteList

  • Type: List of strings

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

WebhookConfiguration

autoInactiveTimeout

com.unblu.webhook.autoInactiveTimeout

  • Type: Integer

  • Default: 172800000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout (in milliseconds) after which an endpoint will be set to inactive if all requests sent to it failed.

Webhook proxy URL

com.unblu.webhook.proxyUrl

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Proxy URL to be used by the unblu server to access the webhook endpoints. Supported format: http(s)://<host>:<port> (no authentication, no other protocols)

realtimeAutoInactiveTimeout

com.unblu.webhook.realtimeAutoInactiveTimeout

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum time (in milliseconds) after which an endpoint corresponding to a real time webhook event will be set to inactive if all requests sent to it failed.

realtimeConnectTimeout

com.unblu.webhook.realtimeConnectTimeout

  • Type: Integer

  • Default: 2000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout waited (in milliseconds) for the connection to be established to the endpoint before cancelling a realtime webhook delivery request.

realtimeObsoleteTimeout

com.unblu.webhook.realtimeObsoleteTimeout

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum time (in milliseconds) a real time webhook event will stay in the queue before it is treated as obsolete and is deleted.

realtimeRequestTimeout

com.unblu.webhook.realtimeRequestTimeout

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout waited (in milliseconds) for the server before cancelling a realtime webhook delivery request.

realtimeRetryInitialInterval

com.unblu.webhook.realtimeRetryInitialInterval

  • Type: Integer

  • Default: 500

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time waited (in milliseconds) for the first retry for a failed realtime webhook delivery. Subsequent retries will double the previous time (Binary exponential backoff strategy with an upper limit).

realtimeRetryMaxInterval

com.unblu.webhook.realtimeRetryMaxInterval

  • Type: Integer

  • Default: 3000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Max waiting time (in milliseconds) between two retries of a realtime webhook delivery. (It will be used if the double of the previous retry time exceeds this threshold).

retryInitialInterval

com.unblu.webhook.retryInitialInterval

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time waited (in milliseconds) for the first retry for a failed webhook delivery. Subsequent retries will double the previous time (Binary exponential backoff strategy with an upper limit).

retryMaxInterval

com.unblu.webhook.retryMaxInterval

  • Type: Integer

  • Default: 10800000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Max waiting time (in milliseconds) between two retries of a webhook delivery. (If the double of the previous retry time exceeds this threshold it will be used).

webhookConnectTimeout

com.unblu.webhook.webhookConnectTimeout

  • Type: Integer

  • Default: 5000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout waited (in milliseconds) for the connection the endpoint to be established before cancelling a webhook delivery request.

webhookDeliveryWorkers

com.unblu.webhook.webhookDeliveryWorkers

  • Type: Integer

  • Default: 5

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Number of webhook delivery workers per node processing and sending webhooks in parallel.

webhookObsoleteTimeout

com.unblu.webhook.webhookObsoleteTimeout

  • Type: Integer

  • Default: 172800000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum time (in milliseconds) a webhook event will stay in the queue before it is treated as obsolete and is deleted.

webhookRequestTimeout

com.unblu.webhook.webhookRequestTimeout

  • Type: Integer

  • Default: 30000

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout waited (in milliseconds) for the server before cancelling a webhook delivery request.

webhookRequestUserAgent

com.unblu.webhook.webhookRequestUserAgent

  • Type: String

  • Default: Unblu-Hookshot

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

User agent used for webhook deliveries.

Conversation invitation configuration

Invitation types subject to deputy delegation

com.unblu.session.deputyDelegationEnabledInvitationTypes

Only visible if: com.unblu.messenger.enableDeputyDelegation=true

  • Type: List of string with allowed values:s

    • agent_forwarding

    • agent_invitation

    • conversation_request

  • Default: CONVERSATION_REQUEST

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Only invitation types listed here are delegated to an invitee’s deputies. All other invitation types remain with the original invitee.

Email invitation timeout (in ms)

com.unblu.session.emailTimeout

  • Type: Integer

  • Default: 86400000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout in milliseconds for email invitations

Conversation reservation timeout (in ms)

com.unblu.session.inboundConversationReservationTimeout

  • Type: Integer

  • Default: 20000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time in milliseconds that an inbound conversation is reserved for an agent before it is automatically requeued and reserved for another agent

linkTimeout

com.unblu.session.linkTimeout

  • Type: Integer

  • Default: 86400000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout in milliseconds before a link invitation times out

PIN pattern

com.unblu.session.pinPattern

  • Type: String

  • Default: [1-9]{1}[0-9]{5}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern for the PIN code

PIN invitation timeout (in ms)

com.unblu.session.pinTimeout

  • Type: Integer

  • Default: 120000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout, in milliseconds, for PIN invitations

Conversation template configuration

Conversation template ID list

com.unblu.conversation.template.agentTemplateIds

  • Type: List of entity references

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

List of conversation template IDs for agents. If no value is set for a specific engagement type, the default template for that engagement type will be used.

Conversation template ID for audio

com.unblu.conversation.template.audioTemplateId

Only visible if: com.unblu.license.account.featureAudioAndVideoChat is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template ID for audio requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for chat

com.unblu.conversation.template.chatTemplateId

Only visible if: com.unblu.messenger.textChatEnabled=true

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for chat requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for embedded co-browsing

com.unblu.conversation.template.domCapBrowserTemplateId

Only visible if: com.unblu.license.account.featureEmbeddedCobrowsing is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for embedded co-browsing requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for universal co-browsing

com.unblu.conversation.template.headlessBrowserTemplateId

Only visible if: com.unblu.license.account.featureUniversalCobrowsing is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for universal co-browser requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for mobile co-browsing

com.unblu.conversation.template.mobileCobrowsingTemplateId

Only visible if: com.unblu.license.account.featureMobileSdkVisitor is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for mobile co-browsing requests. If no value is set, the default template for this engagement type will be used.

Template IDs for new scheduled conversations

com.unblu.conversation.template.newScheduledConversationTemplateIds

Only visible if: com.unblu.messenger.scheduledConversationEnabled=true

  • Type: List of entity references

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

List of scheduled conversation template IDs available to agents when creating a new scheduled conversation. If no value is set, all the scheduled conversation templates will be available.

Conversation template ID for offline chat

com.unblu.conversation.template.offlineChatTemplateId

Only visible if: com.unblu.messenger.textChatEnabled=true

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for offline chat requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for screen sharing requests

com.unblu.conversation.template.screenSharingTemplateId

Only visible if: com.unblu.license.account.featureScreenSharing is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template ID for screen sharing requests. If no value is set, the default template for the engagement type will be used.

Conversation template ID for video requests

com.unblu.conversation.template.videoTemplateId

Only visible if: com.unblu.license.account.featureAudioAndVideoChat is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template ID for video requests. If no value is set, the default template for this engagement type will be used.

visitorCobrowsingTemplateId

com.unblu.conversation.template.visitorCobrowsingTemplateId

Only visible if: com.unblu.license.account.featureEmbeddedCobrowsing is defined

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template id for visitor co-browsing requests. If no value is set, the default template for this engagement type will be used.

Conversation template ID for whiteboard requests

com.unblu.conversation.template.whiteboardTemplateId

Only visible if: com.unblu.license.account.featureWhiteboard is defined, com.unblu.platform.enablePreview=true

  • Type: Entity reference

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Conversation template ID for whiteboard requests. If no value is set, the default template for the engagement type will be used.

Messenger configuration

Enable "call" feature

com.unblu.messenger.callEnabled

Only visible if: com.unblu.license.account.featureAudioAndVideoChat is defined

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure calls in conversation templates

Enable "context migration co-browsing" feature

com.unblu.messenger.contextMigrationCoBrowsingEnabled

Only visible if: com.unblu.license.account.featureUniversalCobrowsing is defined

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure context migration co-browsing in conversation templates

Conversation rating scale

com.unblu.messenger.conversationRatingScale

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The number of stars that can be given to rate a conversation during offboarding

Enable "document co-browsing" feature

com.unblu.messenger.documentCoBrowsingEnabled

Only visible if: com.unblu.license.account.featureDocumentCobrowsing is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure document co-browsing in conversation templates

Enable "embedded co-browsing" feature

com.unblu.messenger.embeddedCoBrowsingEnabled

Only visible if: com.unblu.license.account.featureEmbeddedCobrowsing is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure embedded co-browsing in conversation templates

Enable deputy delegation

com.unblu.messenger.enableDeputyDelegation

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable "file sharing" feature

com.unblu.messenger.fileSharingEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure file sharing in conversation templates

Ignore agent availability check when creating new conversations

com.unblu.messenger.ignoreAgentAvailabilityForOnlineRequest

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

This allows Unblu to create online conversation requests even if all agents are offline. Set to "true" to ensure compatibility between Unblu 7 version 3.x of the Unblu mobile SDKs.

Enable mobile agent SDK

com.unblu.messenger.mobileAgentSdkEnabled

Only visible if: com.unblu.license.account.featureMobileSdkAgent is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable "mobile co-browsing" feature

com.unblu.messenger.mobileCoBrowsingEnabled

Only visible if: com.unblu.license.account.featureMobileSdkVisitor is defined, com.unblu.messenger.mobileVisitorSdkEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure mobile co-browsing in conversation templates

Enable mobile visitor SDK

com.unblu.messenger.mobileVisitorSdkEnabled

Only visible if: com.unblu.license.account.featureMobileSdkVisitor is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable "conversation recording" feature

com.unblu.messenger.recordingEnabled

Only visible if: com.unblu.license.account.featureRecording is defined

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure recording in conversation templates

Enable "scheduled conversation" feature

com.unblu.messenger.scheduledConversationEnabled

Only visible if: com.unblu.license.account.featureScheduledConversation is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure scheduled conversations in conversation templates.

Enable "screen sharing" feature

com.unblu.messenger.screenSharingEnabled

Only visible if: com.unblu.license.account.featureScreenSharing is defined

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure screen sharing in conversation templates

Enable starting with audio call

com.unblu.messenger.startWithAudioCallOptionEnabled

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with an audio call. The configuration property callEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showAudioCallEngagementOption.

Enable starting with chat

com.unblu.messenger.startWithChatOptionEnabled

Only visible if: com.unblu.messenger.textChatEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with text chat. The configuration property textChatEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showChatEngagementOption.

Enable starting with embedded co-browsing

com.unblu.messenger.startWithEmbeddedCobrowsingOptionEnabled

Only visible if: com.unblu.messenger.embeddedCoBrowsingEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with embedded co-browsing. The configuration property embeddedCoBrowsingEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showRequestEmbeddedCobrowsingEngagementOption.

Enable starting with mobile co-browsing

com.unblu.messenger.startWithMobileCobrowsingOptionEnabled

Only visible if: com.unblu.messenger.mobileCoBrowsingEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with mobile co-browsing. The configuration property mobileCoBrowsingEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showRequestMobileCobrowsingEngagementOption.

Enable starting with offline chat

com.unblu.messenger.startWithOfflineChatOptionEnabled

Only visible if: com.unblu.messenger.textChatEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with offline text chat. The configuration property textChatEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showOfflineChatEngagementOption.

Enable starting with screen sharing

com.unblu.messenger.startWithScreenSharingOptionEnabled

Only visible if: com.unblu.messenger.screenSharingEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with screen sharing. The configuration property screenSharingEnabled must be enabled for the setting to have an effect. To make the option available in the engagment UI, you must also enable the configuration property showRequestScreenSharingEngagementOption.

Enable starting with PIN

com.unblu.messenger.startWithTalkOptionEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session by entering a PIN. To make the option available in the engagement UI, you must also enable the configuration property showPinEngagementOption.

Enable starting with context migration co-browsing

com.unblu.messenger.startWithUniversalCobrowsingOptionEnabled

Only visible if: com.unblu.messenger.contextMigrationCoBrowsingEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with context migration co-browsing. The configuration property contextMigrationCoBrowsingEnabled must be enabled for the setting to have an effect.

Enable starting with video call

com.unblu.messenger.startWithVideoCallOptionEnabled

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with a video call. The configuration property callEnabled must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showVideoCallEngagementOption.

Enable starting with whiteboard

com.unblu.messenger.startWithWhiteboardOptionEnabled

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Let visitors start a session with the whiteboard. The configuration properties whiteboardEnabled and enablePreview must be enabled for the setting to have an effect. To make the option available in the engagement UI, you must also enable the configuration property showRequestWhiteboardEngagementOption.

Enable "text chat" feature

com.unblu.messenger.textChatEnabled

Only visible if: com.unblu.license.account.featureTextChat is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable the "text chat" feature. If 'true', you can enable and configure text chat in conversation templates.

Enable "universal co-browsing" feature

com.unblu.messenger.universalCoBrowsingEnabled

Only visible if: com.unblu.license.account.featureUniversalCobrowsing is defined

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure universal co-browsing in conversation templates

Use person fallback avatar

com.unblu.messenger.usePersonAvatarFallback

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Use a fallback avatar if none is defined for a person. The fallback avatar is determined in the following order: person → team → parent team → account

Use recipient fallback avatar

com.unblu.messenger.useRecipientAvatarFallback

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Use a fallback avatar if none is defined for a recipient. The fallback avatar is determined in one of the following ways, depending on the type of recipient: person → team → parent team → account, named-area → account

Enable "video call background replacement" feature

com.unblu.messenger.videoBackgroundReplacementEnabled

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure video background replacement in conversation templates

Enable "whiteboard" feature

com.unblu.messenger.whiteboardEnabled

Only visible if: com.unblu.license.account.featureWhiteboard is defined, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If "true", you can enable and configure the whiteboard in conversation templates

NavigationHistoryConfiguration

trackContextMigrationCoBrowsingHistory

com.unblu.navigationhistory.trackContextMigrationCoBrowsingHistory

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether or not the navigation history in context migration co-browsing should be tracked.

trackVisitorHistory

com.unblu.navigationhistory.trackVisitorHistory

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether or not the navigation history of visitors (urls navigated to in browser) should be tracked.

AcsCallConfig

Azure Communication Services (ACS) access key

com.unblu.conversation.call.acs.accessKey

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A valid access key belonging to the configured Azure Communication Services resource

Azure Communication Services (ACS) resource endpoint URL

com.unblu.conversation.call.acs.resourceEndpointUrl

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL used for API calls between the Unblu Collaboration Server and ACS. The resource endpoint URL usually has the format: https://<resource-name>.communication.azure.com

CallServiceProviderConfig

Call service provider

com.unblu.conversation.call.callServiceProvider

  • Type: String with allowed values:

    • acs

    • livekit

    • opentok

  • Default: OPENTOK

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The service provider to use for audio and video calls.

Screen sharing service provider

com.unblu.conversation.call.screenSharingServiceProvider

Only visible if: com.unblu.messenger.screenSharingEnabled=true

  • Type: String with allowed values:

    • auto

    • force_unblu_p2p

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The service provider to use for screen sharing. By default the call service provider will be used if it supports screen sharing integration, otherwise Unblu native P2P webRTC will be used.

LiveKitCallConfig

LiveKit API key

com.unblu.conversation.call.livekit.apiKey

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

API key used to identify Unblu with LiveKit

LiveKit API proxy URL

com.unblu.conversation.call.livekit.apiProxyUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Forward proxy URL used for API calls from the Unblu Collaboration Server to the LiveKit server. The format of the URL must be <socks5|http>://[<username>:<password>@]<host>:<port>

LiveKit API secret

com.unblu.conversation.call.livekit.apiSecret

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Secret used by the Unblu Collaboration Server to authenticate against the LiveKit server and create access tokens for the clients

LiveKit API URL

com.unblu.conversation.call.livekit.apiUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL pointing to the LiveKit server used by the Unblu Collaboration Server for API calls

Use a custom TURN server for LiveKit

com.unblu.conversation.call.livekit.customTurnEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, the custom TURN server configuration from Unblu is used (see 'com.unblu.webrtc'), otherwise the LiveKit TURN server

Enable LiveKit simulcast for screen sharing and video

com.unblu.conversation.call.livekit.enableSimulcast

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Any additional simulcast configuration value are only applied if this configuration is enabled

Maximum bitrate of default screen sharing layer

com.unblu.conversation.call.livekit.manualScreenShareMaxBitrate

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareEncodingSettings=true

  • Type: Integer

  • Default: 4000000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In bits per second (bps). Only applied if manual screen sharing encoding settings are enabled.

Maximum framerate of default screen sharing layer

com.unblu.conversation.call.livekit.manualScreenShareMaxFramerate

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareEncodingSettings=true

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In frames per second (fps). Only applied if manual screen sharing encoding settings are enabled.

Height of screen sharing simulcast layer

com.unblu.conversation.call.livekit.manualScreenShareSimulcastHeight

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareSimulcastLayer=true

  • Type: Integer

  • Default: 1200

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual screen sharing simulcast is enabled.

Maximum bitrate of screen sharing simulcast layer

com.unblu.conversation.call.livekit.manualScreenShareSimulcastMaxBitrate

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareSimulcastLayer=true

  • Type: Integer

  • Default: 350000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In bits per second (bps). Only applied if manual screen sharing simulcast is enabled.

Maximum framerate of screen sharing simulcast layer

com.unblu.conversation.call.livekit.manualScreenShareSimulcastMaxFramerate

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareSimulcastLayer=true

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In frames per second (fps). Only applied if manual screen sharing simulcast is enabled.

Width of screen sharing simulcast layer

com.unblu.conversation.call.livekit.manualScreenShareSimulcastWidth

Only visible if: com.unblu.conversation.call.livekit.useManualScreenShareSimulcastLayer=true

  • Type: Integer

  • Default: 1920

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual screen sharing simulcast is enabled.

Height of first (half quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoHalfSimulcastLayerHeight

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 720

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual video simulcast is enabled.

Maximum bitrate of first (half quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoHalfSimulcastLayerMaxBitrate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 1700000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In bits per second (bps). Only applied if manual video simulcast is enabled.

Maximum framerate of first (half quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoHalfSimulcastLayerMaxFramerate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In frames per second (fps). Only applied if manual video simulcast is enabled.

Width of first (half quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoHalfSimulcastLayerWidth

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 1280

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual video simulcast is enabled.

Maximum bitrate of default video (camera) layer

com.unblu.conversation.call.livekit.manualVideoMaxBitrate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoEncodingSettings=true

  • Type: Integer

  • Default: 3000000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In bits per second (bps). Only applied if manual video encoding settings are enabled. The default video layer is the full quality video (camera) layer.

Maximum framerate default video (camera) layer

com.unblu.conversation.call.livekit.manualVideoMaxFramerate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoEncodingSettings=true

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In frames per second (fps). Only applied if manual video encoding settings are enabled. The default video layer is the full quality video (camera) layer.

Height of second (quarter quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoQuarterSimulcastLayerHeight

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 360

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual video simulcast is enabled.

Maximum bitrate of second (quarter quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoQuarterSimulcastLayerMaxBitrate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 450000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In bits per second (bps). Only applied if manual video simulcast is enabled.

Maximum framerate of second (quarter quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoQuarterSimulcastLayerMaxFramerate

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In frames per second (fps). Only applied if manual video simulcast is enabled.

Width of second (quarter quality) video (camera) simulcast layer

com.unblu.conversation.call.livekit.manualVideoQuarterSimulcastLayerWidth

Only visible if: com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers=true

  • Type: Integer

  • Default: 640

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

In pixels (px). Only applied if manual video simulcast is enabled.

LiveKit signaling server URL

com.unblu.conversation.call.livekit.serverUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

URL used by the clients (browsers) to connect to the LiveKit server

Use manual screen sharing encoding settings

com.unblu.conversation.call.livekit.useManualScreenShareEncodingSettings

Only visible if: com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The manual screen sharing encoding settings are used for the full quality layer. This layer may optionally be accompanied by up to 2 simulcast layers. If enabled, the manually configured values override the default bitrate and framerate calculated by LiveKit.

Use manual screen sharing simulcast layer

com.unblu.conversation.call.livekit.useManualScreenShareSimulcastLayer

Only visible if: com.unblu.conversation.call.livekit.enableSimulcast=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, the manually configured simulcast layer overrides the default LiveKit simulcast layers

Use manual video (camera) encoding settings

com.unblu.conversation.call.livekit.useManualVideoEncodingSettings

Only visible if: com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The manual video encoding settings are used for the full quality layer. This layer may optionally be accompanied by up to 2 simulcast layers. If enabled, the manually configured values override the default bitrate and framerate calculated by LiveKit.

Use manual video simulcast layers

com.unblu.conversation.call.livekit.useManualVideoSimulcastLayers

Only visible if: com.unblu.conversation.call.livekit.enableSimulcast=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, the manually configured simulcast layers override the default LiveKit simulcast layers

Vonage audio and video calls

Vonage Video API key

com.unblu.chat.videochat.apiKey

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Encrypted Vonage Video API key used for video and audio calls. Contact the Unblu support team to obtain the key.

Vonage Video API secret

com.unblu.chat.videochat.apiSecret

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Vonage Video API URL

com.unblu.chat.videochat.apiUrl

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Used by the Unblu server to manage calls through the Vonage REST API. Leave empty to use the default URL.

Use custom TURN server

com.unblu.chat.videochat.customTurnEnabled

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, the custom TURN server configuration from Unblu is used (see 'com.unblu.webrtc'). If not enabled, the Vonage TURN server is used.

Enable call recording

com.unblu.chat.videochat.enableArchiving

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, all calls are recorded automatically using Vonage’s archiving feature. The session type must be set to 'ROUTED' or 'AUTO' for this setting to work. Unblu’s conversation recording feature is an alternative solution.

Enable SIP dial out

com.unblu.chat.videochat.enableSipDialOut

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, SIP dial out will be enabled allowing dial in with a landline phone (PSTN) when used together with a SIP gateway. The session type must be set to 'ROUTED' or 'AUTO' for this setting to work.

Proxy authentication scheme

com.unblu.chat.videochat.proxyAuthScheme

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String with allowed values:

    • basic

    • digest

    • kerberos

    • ntlm

    • spnego

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Proxy authentication schema to use in conjunction with the configuration property com.unblu.core.server.collaboration.conversation.call.tokbox.proxyUrl. If the proxy URL includes authentication information, this configuration property must be set.

Proxy URL

com.unblu.chat.videochat.proxyUrl

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Proxy URL to be used by the Unblu server to access the Vonage Video API cloud (https://api.opentok.com). Supported format: http://[<username>:<password>@]<host>:<port> (no other protocols). Note: If you specify username and password you must also specify the proxy authentication scheme in the corresponding separate config property.

Vonage call session type

com.unblu.chat.videochat.sessionType

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: String with allowed values:

    • auto

    • relayed

    • routed

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Possible values: RELAYED: peer-to-peer ROUTED: routed via Vonage Video API server AUTO: ROUTED if archiving is enabled, RELAYED otherwise

SIP dial out password

com.unblu.chat.videochat.sipPassword

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Password used to connect to the SIP endpoint e.g. Vonage SIP Interconnect API secret when using the Vonage Video API.

SIP dial out URI

com.unblu.chat.videochat.sipUri

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URI of the SIP server to dial out to. The format should follow "sip:user@provider" e.g. sip:1-999-123-4567@voip-provider.example.net

SIP dial out username

com.unblu.chat.videochat.sipUsername

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

username used to connect to the SIP endpoint e.g. Vonage SIP Interconnect API APIKey when using the Vonage Video API.

VonageSipDialInConfig

Vonage SIP Interconnect API key

com.unblu.conversation.call.dialin.vonage.apiKey

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

API key used to identify Unblu with Vonage SIP Interconnect

Vonage SIP Interconnect API private key

com.unblu.conversation.call.dialin.vonage.apiPrivateKey

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Secret used by the Unblu Collaboration Server to authenticate against the Vonage SIP Interconnect API

Vonage SIP Interconnect API Proxy

com.unblu.conversation.call.dialin.vonage.apiProxyUrl

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Forward proxy URL used for API calls from the Unblu Collaboration Server to the Vonage SIP Interconnect API. The format of the URL must be http[s]://[<username>:<password>@]<host>:<port>

Vonage SIP Interconnect API public key

com.unblu.conversation.call.dialin.vonage.apiPublicKey

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Secret used by the Unblu Collaboration Server to authenticate against the Vonage SIP Interconnect API

Vonage SIP Interconnect API Region

com.unblu.conversation.call.dialin.vonage.apiRegion

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String with allowed values:

    • ap_singapore

    • ap_sydney

    • eu_dublin

    • eu_frankfurt

    • us_oregon

    • us_virginia

  • Default: EU_FRANKFURT

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Data center region used for the Vonage Voice API

Vonage SIP Interconnect API secret

com.unblu.conversation.call.dialin.vonage.apiSecret

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

API secret used to identify Unblu with Vonage SIP Interconnect

Vonage SIP Interconnect application ID used for Unblu

com.unblu.conversation.call.dialin.vonage.applicationId

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

ID of the application in the Vonage SIP Interconnect used by the Unblu Collaboration Server for API calls and webhooks. The application should be linked with at least one dial in number.

Enable call dial-in via Vonage SIP Interconnect

com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn

Only visible if: com.unblu.messenger.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Requires all other configuration properties in the group to be configured as well

URL used to register for Vonage SIP Interconnect webhooks

com.unblu.conversation.call.dialin.vonage.webhookEndpointBaseUrl

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

When not defined the webhook base server URL is used. This property can be used to override that value. The URL should contain the "webhook" entry path (e.g. "/webhook") and must not end with a "/"

Vonage SIP Interconnect webhook secret

com.unblu.conversation.call.dialin.vonage.webhookSecret

Only visible if: com.unblu.conversation.call.dialin.vonage.enableVonageCallDialIn=true, com.unblu.platform.enablePreview=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Shared secret used by Vonage SIP Interconnect to sign Webhooks sent to Unblu using a HMAC-256 signature allowing Unblu to verify a Webhook is really sent by Vonage

Conversation activity

Activity categories to track

com.unblu.conversation.activity.activityCategoriesToTrack

  • Type: List of string with allowed values:s

    • call

    • chat

    • conversation_open

    • layers_collaboration

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The categories you select trigger activity updates

Layers that trigger an activity while displayed

com.unblu.conversation.activity.layerTypesThatTriggerActivityWhileDisplayed

  • Type: List of string with allowed values:s

    • context_migration_cobrowsing

    • document_cobrowsing

    • embedded_cobrowsing

    • mobile_cobrowsing

    • screen_sharing

    • universal_cobrowsing

    • whiteboard

  • Default: EMBEDDED_COBROWSING,CONTEXT_MIGRATION_COBROWSING,MOBILE_COBROWSING,UNIVERSAL_COBROWSING,DOCUMENT_COBROWSING,WHITEBOARD,SCREEN_SHARING

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

List of co-browsing layer types that trigger activity for all participants in the conversation while they’re active, independent of their interaction with a layer. This is often needed when one participant is presenting to the other participant. Note: only has an effect if the category LAYERS_COLLABORATION is enabled in the list of activity categories to track.

Conversation "auto-pause notifications" configuration

Enable "active call" auto-pause

com.unblu.conversation.autopausenotifications.enableActiveCallAutoPause

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable auto-pausing for the reason "active call"

Enable "active collaboration" auto-pause reason

com.unblu.conversation.autopausenotifications.enableActiveCollaborationAutoPause

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable auto-pausing for the reason "active collaboration"

Conversation "awaited person type" configuration

Allow changing awaited person type

com.unblu.conversation.awaitedpersontype.allowChangeConversationAwaitedPersonType

  • Type: List of string with allowed values:s

    • assigned_agent

    • ghost

    • recorder

    • secondary_agent

  • Default: ASSIGNED_AGENT,SECONDARY_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to change the awaited person type of a conversation

Automatically requeue unassigned conversations awaiting agent

com.unblu.conversation.awaitedpersontype.autoRequeueUnassignedConversationAwaitingForAgent

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The conversation is automatically requeued if the conversation state changes to "UNASSIGNED" and the awaited person type is "AGENT" or if the awaited person type changes to "AGENT" and the conversation state is "UNASSIGNED"

Automatically set awaited person type of "QUEUED" conversations to "AGENT"

com.unblu.conversation.awaitedpersontype.autoSetAwaitedPersonTypeToAgentOnConversationQueued

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Automatically set awaited person type of "ACTIVE" conversations to "NONE"

com.unblu.conversation.awaitedpersontype.autoSetAwaitedPersonTypeToNoneOnConversationActive

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Request change awaited person type if assigned agent leaves conversation

com.unblu.conversation.awaitedpersontype.onAssigneeLeaveShowChangeAwaitedPersonTypeDialog

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show a dialog to set the awaited person type when the assigned agent leaves the conversation. The assigned agent must have permission to change the awaited person type.

Conversation bots

Bot dialog response offer timeout

com.unblu.conversation.bot.botDialogOfferResponseTimeout

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum time in seconds that a bot has to respond to a dialog offer. If the bot doesn’t respond within this time, it is automatically excluded from the dialog.

Maximum time between two bot dialog messages (in s)

com.unblu.conversation.bot.botMaxTimeBetweenMessages

  • Type: Integer

  • Default: 180

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum time, in seconds, that may pass between two messages of a bot dialog. If the timeout is reached, the conversation is treated as idle. If the bot’s successful completion is required, the conversation is canceled.

Minimum time between bot messages (in ms)

com.unblu.conversation.bot.botMinTimeBetweenMessages

  • Type: Integer

  • Default: 1500

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The minimum time, in milliseconds, that must pass between two bot messages, or a user message and a bot’s response. If a bot sends messages faster, Unblu automatically delays their delivery to conform to this time.

Enable all external dialog bots

com.unblu.conversation.bot.externalBotsEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

All bots are treated as optional bots. Overrides the configuration properties optionalExternalBotIds and mandatoryExternalBotIds.

Mandatory external dialog bot IDs

com.unblu.conversation.bot.mandatoryExternalBotIds

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The list of active external dialog bots you want to enable in this conversation. If a bot can’t be contacted or stops responding, the boarding process is aborted. This list is ignored if externalBotsEnabled is set to true.

Optional external dialog bot IDs

com.unblu.conversation.bot.optionalExternalBotIds

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The list of active external dialog bots you want to enable in this conversation. Bots that can’t be contacted or that stop responding are ignored. This list is ignored if externalBotsEnabled is set to true.

Conversation call

Allow personal dial-in for calls

com.unblu.conversation.call.allowPersonalDialIn

Only visible if: com.unblu.conversation.call.enableDialIn=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants that may use audio through their phone using the dial-in feature

Allow public dial-in for calls

com.unblu.conversation.call.allowPublicDialIn

Only visible if: com.unblu.conversation.call.enableDialIn=true, com.unblu.conversation.invitation.allowPublicLinkAccess=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If enabled, a public call dial-in token is created that allows anyone with the token to join the call

Allow "request callback" when unavailable for call

com.unblu.conversation.call.allowRequestCallbackWhenUnvailableForCall

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If enabled a button is displayed in the "unavailable for call" UI

Participants allowed to start audio calls

com.unblu.conversation.call.allowStartAudioCall

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to start video calls

com.unblu.conversation.call.allowStartVideoCall

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participation types allowed to start calls even though all other participants are unavailable

com.unblu.conversation.call.allowStartingCallsWhenOthersUnavailable

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The configuration property only has an effect if automatically starting and joining calls is disabled

Participants allowed to take snapshots in video calls

com.unblu.conversation.call.allowTakeSnapshot

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

"Leave call" options for assigned agent

com.unblu.conversation.call.assignedAgentHangUpCallBehaviours

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • close_conversation

    • end_conversation

    • leave_call

    • leave_conversation

  • Default: LEAVE_CALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The "leave call" options available to the assigned agent. The options only work if the assigned agent has permission to end or leave a conversation, depending on the options selected. If no option is selected, the option to leave a call is hidden.

Automatically prompt personal dial-in

com.unblu.conversation.call.autoPromptDialIn

Only visible if: com.unblu.conversation.call.enableDialIn=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants to automatically prompt for the personal dial-in option when joining a call

Automatically start and join calls

com.unblu.conversation.call.autoStartAndJoinCalls

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If enabled, calls start automatically once the first person opens the conversation. Furthermore, every participant who opens the conversation automatically joins the call.

Type of call to start automatically

com.unblu.conversation.call.autoStartCallType

Only visible if: com.unblu.conversation.call.autoStartAndJoinCalls=true

  • Type: String with allowed values:

    • audio

    • video

  • Default: VIDEO

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The type of call to start when the first participant opens the conversation

"Call not answered" timeout (in s)

com.unblu.conversation.call.callNotAnsweredTimeoutSeconds

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: Integer

  • Default: 30

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

"Leave call" options for context person

com.unblu.conversation.call.contextPersonHangUpCallBehaviours

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • close_conversation

    • end_conversation

    • leave_call

    • leave_conversation

  • Default: LEAVE_CALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The "leave call" options available to the context person. The options only work if the context person has permission to end or leave a conversation, depending on the options selected. If no option is selected, the option to leave a call is hidden.

Enable camera in audio

com.unblu.conversation.call.enableCameraInAudio

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants to show the camera button to in audio calls

Enable camera in video

com.unblu.conversation.call.enableCameraInVideo

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants to show the camera button to in video calls

Enable dial-in feature for calls

com.unblu.conversation.call.enableDialIn

Only visible if: com.unblu.conversation.feature.callEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If enabled, calls can be joined via phone (PSTN) dial-in. For the feature to work, public and/or personal dial-in must also be enabled. To enable dial-in, the SIP gateway must be configured separately for each call service provider.

Enable microphone in audio

com.unblu.conversation.call.enableMicrophoneInAudio

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants to show the microphone button to in audio calls

Enable microphone button in video calls

com.unblu.conversation.call.enableMicrophoneInVideo

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants to show the microphone button to in video calls

Participants with access to background blur button

com.unblu.conversation.call.enableVideoBackgroundReplacement

Only visible if: com.unblu.conversation.feature.callEnabled=true, com.unblu.messenger.videoBackgroundReplacementEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Forward call to hidden agents after timeout

com.unblu.conversation.call.forwardToHiddenAgents

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If enabled, unanswered calls are first be forwarded to hidden agents (if available) before they are ended

Personal dial-in token length

com.unblu.conversation.call.personalDialInTokenLength

Only visible if: com.unblu.conversation.call.enableDialIn=true

  • Type: Integer

  • Default: 4

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

    • Maximum value: 20

The number of digits used for personal call dial-in tokens. The number can be low because tokens are ephemeral: they’re allocated dynamically during a call and discarded when the call ends.

Public dial-in token length

com.unblu.conversation.call.publicDialInTokenLength

Only visible if: com.unblu.conversation.call.enableDialIn=true

  • Type: Integer

  • Default: 8

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

    • Maximum value: 20

The number of digits used for public call dial-in tokens. Public tokens must be longer than personal tokens as these are permanently reserved for conversations until the conversation has ended.

"Leave call" options for secondary agents

com.unblu.conversation.call.secondaryAgentHangUpCallBehaviours

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • close_conversation

    • end_conversation

    • leave_call

    • leave_conversation

  • Default: LEAVE_CALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The "leave call" options available to secondary agents. The options only work if the secondary agent has permission to end or leave a conversation, depending on the options selected. If no option is selected, the option to leave a call is hidden.

"Leave call" options for secondary visitors

com.unblu.conversation.call.secondaryVisitorHangUpCallBehaviours

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • close_conversation

    • end_conversation

    • leave_call

    • leave_conversation

  • Default: LEAVE_CALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The "leave call" options available to secondary visitors. The options only work if the secondary visitor has permission to end or leave a conversation, depending on the options selected. If no option is selected, the option to leave a call is hidden.

Start video call with camera enabled

com.unblu.conversation.call.startWithCameraEnabledInVideo

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants whose camera is enabled when a video call starts

Start audio call with microphone enabled

com.unblu.conversation.call.startWithMicrophoneEnabledInAudio

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants whose microphone is enabled when an audio call starts

Start video call with microphone enabled

com.unblu.conversation.call.startWithMicrophoneEnabledInVideo

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants whose microphone is enabled when a video call starts

Participants with background blurred when video starts

com.unblu.conversation.call.startWithVideoBackgroundReplacementEnabled

Only visible if: com.unblu.conversation.feature.callEnabled=true, com.unblu.messenger.videoBackgroundReplacementEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Reasons a conversation participant may be unavailable for calls

com.unblu.conversation.call.unavailableForCallReasons

Only visible if: com.unblu.conversation.feature.callEnabled=true

  • Type: List of string with allowed values:s

    • away

    • notifications_paused

    • offline

  • Default: NOTIFICATIONS_PAUSED

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The configuration property only has an effect if automatically starting and joining calls is disabled

Chat suggestions

Source for suggestions

com.unblu.conversation.chatsuggestion.suggestionSourceId

Only visible if: com.unblu.platform.enablePreview=true

  • Type: Entity reference

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Source used to get suggestions for messages in this conversation. Leave empty to disable chat suggestions.

Conversation collaboration

Allow control of navigation bar in context migration co-browsing

com.unblu.conversation.collaboration.action.allowControlNavigationBarInContextMigrationCobrowsing

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow control of navigation bar in embedded co-browsing

com.unblu.conversation.collaboration.action.allowControlNavigationBarInEmbeddedCobrowsing

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow control of navigation bar in universal co-browsing

com.unblu.conversation.collaboration.action.allowControlNavigationBarInUniversalCobrowsing

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use developer tools in universal co-browsing

com.unblu.conversation.collaboration.action.allowHeadlessbrowserDeveloperTools

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to inspect conversation visual

com.unblu.conversation.collaboration.action.allowInspectVisual

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participant allowed to use mark mode in context-migration co-browsing

com.unblu.conversation.collaboration.action.allowMarkInContextMigrationCobrowsing

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use mark mode in document co-browsing

com.unblu.conversation.collaboration.action.allowMarkInDocumentCobrowsing

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use mark mode in embedded co-browsing

com.unblu.conversation.collaboration.action.allowMarkInEmbeddedCobrowsing

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The layer owner is automatically excluded

Participants allowed to use mark mode in mobile co-browsing

com.unblu.conversation.collaboration.action.allowMarkInMobileCobrowsing

Only visible if: com.unblu.conversation.feature.mobileCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use mark mode in universal co-browsing

com.unblu.conversation.collaboration.action.allowMarkInUniversalCobrowsing

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use mark mode in whiteboard

com.unblu.conversation.collaboration.action.allowMarkInWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use remote control in context-migration co-browsing

com.unblu.conversation.collaboration.action.allowRemoteControlInContextMigrationCobrowsing

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use remote control in document co-browsing

com.unblu.conversation.collaboration.action.allowRemoteControlInDocumentCobrowsing

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use remote control in embedded co-browsing

com.unblu.conversation.collaboration.action.allowRemoteControlInEmbeddedCobrowsing

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The layer owner is automatically excluded

Participants allowed to use remote control in universal co-browsing

com.unblu.conversation.collaboration.action.allowRemoteControlInUniversalCobrowsing

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use remote control in whiteboard

com.unblu.conversation.collaboration.action.allowRemoteControlInWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to use scroll lock in embedded co-browsing

com.unblu.conversation.collaboration.action.allowScrollLockInEmbeddedCobrowsing

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The layer owner is automatically excluded

Participants allowed to stop context migration co-browsing

com.unblu.conversation.collaboration.action.allowStopContextMigrationCobrowsing

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to stop document co-browsing

com.unblu.conversation.collaboration.action.allowStopDocumentCobrowsing

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to stop embedded co-browsing

com.unblu.conversation.collaboration.action.allowStopEmbeddedCobrowsing

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The layer owner is automatically included

Participants allowed to stop mobile co-browsin

com.unblu.conversation.collaboration.action.allowStopMobileCobrowsing

Only visible if: com.unblu.conversation.feature.mobileCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to stop screen sharing

com.unblu.conversation.collaboration.action.allowStopScreenSharing

Only visible if: com.unblu.conversation.feature.screenSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The layer owner is automatically included

Participants allowed to stop universal co-browsing

com.unblu.conversation.collaboration.action.allowStopUniversalCobrowsing

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to stop whiteboard

com.unblu.conversation.collaboration.action.allowStopWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to view network statistics

com.unblu.conversation.collaboration.action.allowViewNetworkStatistics

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow participants to see inactive layers

com.unblu.conversation.collaboration.action.displayInactiveLayers

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop context migration co-browsing" dialog

com.unblu.conversation.collaboration.action.showStopContextMigrationCoBrowsingDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop document co-browsing" dialog

com.unblu.conversation.collaboration.action.showStopDocumentCoBrowsingDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop embedded co-browsing" dialog

com.unblu.conversation.collaboration.action.showStopEmbeddedCoBrowsingDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop mobile co-browsing" dialog

com.unblu.conversation.collaboration.action.showStopMobileCoBrowsingDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop screen sharing" dialog

com.unblu.conversation.collaboration.action.showStopScreenShareDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop universal co-browsing" dialog

com.unblu.conversation.collaboration.action.showStopUniversalCoBrowsingDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show "stop whiteboard" dialog

com.unblu.conversation.collaboration.action.showStopWhiteboardDialog

Only visible if: com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Approval timeout (in s)

com.unblu.conversation.collaboration.approval.approvalTimeout

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

If no response is given in this time, they are regarded as declined.

Context migration co-browsing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateContextMigration

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Document co-browsing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateDocument

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Embedded co-browsing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateEmbedded

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Mobile co-browsing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateMobile

Only visible if: com.unblu.conversation.feature.mobileCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Screen sharing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateScreenSharing

Only visible if: com.unblu.conversation.feature.screenSharingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Universal co-browsing requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateUniversal

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Whiteboard requires visitor approval

com.unblu.conversation.collaboration.approval.approveActivateWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Approve mark mode in context migration co-browsing

com.unblu.conversation.collaboration.approval.approveMarkContextMigration

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom mark mode in context migration co-browsing requires the visitor’s approval. Visitors themselves never require approval.

Approve mark mode in document co-browsing

com.unblu.conversation.collaboration.approval.approveMarkDocument

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom mark mode in document co-browsing requires the assigned agent’s approval. Assigned agents themselves never require approval.

Approve mark mode in embedded co-browsing

com.unblu.conversation.collaboration.approval.approveMarkEmbedded

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom mark mode in embedded co-browsing requires the visitor’s approval. Visitors themselves never require approval.

Approve mark mode in mobile co-browsing

com.unblu.conversation.collaboration.approval.approveMarkMobile

Only visible if: com.unblu.conversation.feature.mobileCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom mark mode in mobile co-browsing requires the visitor’s approval. Visitors themselves never require approval.

Approve mark mode in universal co-browsing

com.unblu.conversation.collaboration.approval.approveMarkUniversal

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom mark mode in universal co-browsing requires the assigned agent’s approval. Assigned agents themselves never require approval.

Participants who require approval for mark mode on whiteboard

com.unblu.conversation.collaboration.approval.approveMarkWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Approval is granted or denied by the assigned agent. Assigned agents themselves never require approval.

Approve remote control in context migration co-browsing

com.unblu.conversation.collaboration.approval.approveRemoteControlContextMigration

Only visible if: com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom remote control in context migration co-browsing requires the visitor’s approval. Visitors themselves never require approval.

Approve remote control in document co-browsing

com.unblu.conversation.collaboration.approval.approveRemoteControlDocument

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom remote control in document co-browsing requires the assigned agent’s approval. Assigned agents themselves never require approval.

Approve remote control in embedded co-browsing

com.unblu.conversation.collaboration.approval.approveRemoteControlEmbedded

Only visible if: com.unblu.conversation.feature.embeddedCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom remote control in embedded co-browsing requires the visitor’s approval. Visitors themselves never require approval.

Approve remote control in universal co-browsing

com.unblu.conversation.collaboration.approval.approveRemoteControlUniversal

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants for whom remote control in universal co-browsing requires the assigned agent’s approval. Assigned agents themselves never require approval.

Approve whiteboard remote control

com.unblu.conversation.collaboration.approval.approveRemoteControlWhiteboard

Only visible if: com.unblu.conversation.feature.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Approval is granted or denied by the assigned agent. Assigned agents themselves never require approval.

Layer types to stop automatically when inactive

com.unblu.conversation.collaboration.autoStopCollaborationLayerWhenInactive

  • Type: List of string with allowed values:s

    • context_migration_cobrowsing

    • document_cobrowsing

    • embedded_cobrowsing

    • mobile_cobrowsing

    • screen_sharing

    • universal_cobrowsing

    • whiteboard

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Layers started automatically

com.unblu.conversation.collaboration.autostartLayers

  • Type: List of string with allowed values:s

    • context_migration_cobrowsing

    • document_cobrowsing

    • embedded_cobrowsing

    • mobile_cobrowsing

    • screen_sharing

    • universal_cobrowsing

    • whiteboard

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If necessary, an approval request is triggered first

Participants who can reset inactivity timeout

com.unblu.conversation.collaboration.conversationLayerInactivityParticipants

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participant interaction timeout (in s)

com.unblu.conversation.collaboration.conversationLayerInactivityTimeout

  • Type: Integer

  • Default: 300

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The time, in seconds, for a participant to interact with a collaboration layer before it is stopped because of inactivity. The participant must be in the list of conversationLayerInactivityParticipants for their interactions to be taken into account when resetting the timeout.

Inactivity timeout threshold (in s)

com.unblu.conversation.collaboration.conversationLayerInactivityTimeoutTreshold

  • Type: Integer

  • Default: 30

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The threshold, in seconds, before the conversationLayerInactivityTimeout ends. If the threshold is reached, a dialog is displayed indicating that the collaboration layer is about to be stopped because of inactivity. The participant must be in the list of conversationLayerInactivityParticipants to see this dialog.

Participants to show collaboration layer controls

com.unblu.conversation.collaboration.showLayerControls

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show loading splash screen

com.unblu.conversation.collaboration.showLayerLoadingSplash

  • Type: String with allowed values:

    • all

    • local

    • none

    • remote

  • Default: ALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Use ALL for all layers, NONE to disable the splash screen, LOCAL for all local layers (embedded co-browsing, mobile co-browsing, and screen-sharing) or REMOTE for all remote layers (universal, context-migration, and document co-browsing).

Show capturing frame

com.unblu.conversation.collaboration.showVisitorLayerCapturingFrame

  • Type: String with allowed values:

    • all

    • local

    • none

    • remote

  • Default: ALL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Use ALL for all layers, NONE to disable the capturing frame, LOCAL for all local layers (embedded co-browsing, mobile co-browsing, and screen-sharing) or REMOTE for all remote layers (universal, context-migration, and document co-browsing).

Participants allowed to switch between layers

com.unblu.conversation.collaboration.switchLayers

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge

Concierge agent offboarding order

com.unblu.conversation.concierge.conciergeAgentOffboardingOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Agent onboarding flow

com.unblu.conversation.concierge.conciergeAgentOnboardingFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleAgentOnboarding=true

  • Type: List of string with allowed values:s

    • ack_terms_and_conditions

    • done_message

    • greeting_message

    • onboarding_message_1

    • onboarding_message_2

    • onboarding_message_3

  • Default: GREETING_MESSAGE,DONE_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge behavior on timeout during agent onboarding

com.unblu.conversation.concierge.conciergeAgentOnboardingOnTimeoutBehavior

Only visible if: com.unblu.conversation.concierge.conciergeHandleAgentOnboarding=true

  • Type: String with allowed values:

    • abort

    • hand_off

  • Default: ABORT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge agent onboarding order

com.unblu.conversation.concierge.conciergeAgentOnboardingOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge

com.unblu.conversation.concierge.conciergeEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge for agent offboarding

com.unblu.conversation.concierge.conciergeHandleAgentOffboarding

Only visible if: com.unblu.conversation.concierge.conciergeEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge for agent onboarding

com.unblu.conversation.concierge.conciergeHandleAgentOnboarding

Only visible if: com.unblu.conversation.concierge.conciergeEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge for visitor reboarding

com.unblu.conversation.concierge.conciergeHandleReboarding

Only visible if: com.unblu.conversation.concierge.conciergeEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge for visitor offboarding

com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding

Only visible if: com.unblu.conversation.concierge.conciergeEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable concierge for visitor onboarding

com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding

Only visible if: com.unblu.conversation.concierge.conciergeEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge visitor reboarding order

com.unblu.conversation.concierge.conciergeReboardingOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Make "name" question declinable in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorNameQuestionDeclinable

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If skipped, the visitor’s display name is automatically generated name based on "com.unblu.person.displayname.visitorDisplayNameEvaluationOrder", "com.unblu.person.displayname.visitor", and "com.unblu.person.displayname.qualifiedStaticName"

"Canceled" visitor offboarding flow

com.unblu.conversation.concierge.conciergeVisitorOffboardingConversationCanceledFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through for each visitor of a conversation when it is canceled

Visitor offboarding flow definition

com.unblu.conversation.concierge.conciergeVisitorOffboardingConversationEndFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through for each visitor of a conversation when it is ended

"User removed" visitor offboarding flow

com.unblu.conversation.concierge.conciergeVisitorOffboardingKickedFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through when a visitor is removed from a conversation

"Onboarding declined" visitor offboarding flow

com.unblu.conversation.concierge.conciergeVisitorOffboardingOnboardingDeclinedFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through when a visitor doesn’t complete the onboarding process, for example, when they decline the service’s terms & conditions

Concierge visitor offboarding order

com.unblu.conversation.concierge.conciergeVisitorOffboardingOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

"Left conversation" visitor offboarding flow

com.unblu.conversation.concierge.conciergeVisitorOffboardingPersonLeftFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through when a visitor actively leaves the conversation

"Solved by bot" visitor offboarding flow

com.unblu.conversation.concierge.conciergeVisitorOffboardingSolvedByBotFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: List of string with allowed values:s

    • info_message_1

    • info_message_2

    • info_message_3

    • info_message_4

    • info_message_5

    • info_message_6

    • offboarding_reason_message

    • rate_conversation

    • send_log_via_mail

  • Default: OFFBOARDING_REASON_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The visitor offboarding flow that the concierge goes through for each visitor when a conversation ends because it was solved by a bot

Concierge visitor onboarding flow

com.unblu.conversation.concierge.conciergeVisitorOnboardingFlow

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: List of string with allowed values:s

    • ack_terms_and_conditions

    • ask_for_email

    • ask_for_name

    • ask_for_phone

    • ask_for_topic

    • check_agent_availability

    • choose_named_area

    • choose_team

    • done_message

    • greeting_message

    • onboarding_message_1

    • onboarding_message_2

    • onboarding_message_3

  • Default: GREETING_MESSAGE,ACK_TERMS_AND_CONDITIONS,DONE_MESSAGE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Behavior when no agent is available during visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingOnAgentUnavailable

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: String with allowed values:

    • abort

    • end

    • hand_off

  • Default: HAND_OFF

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge behavior on timeout during visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingOnTimeoutBehavior

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: String with allowed values:

    • abort

    • hand_off

  • Default: ABORT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Concierge visitor onboarding order

com.unblu.conversation.concierge.conciergeVisitorOnboardingOrder

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Primary named areas in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingPrimaryNamedAreas

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Primary teams in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingPrimaryTeams

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Secondary named areas in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingSecondaryNamedAreas

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Secondary teams in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorOnboardingSecondaryTeams

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow skipping "rating" question

com.unblu.conversation.concierge.conciergeVisitorRatingQuestionDeclinable

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOffboarding=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow visitors to skip the concierge’s "rating" question

Make "topic question" declinable in visitor onboarding

com.unblu.conversation.concierge.conciergeVisitorTopicQuestionDeclinable

Only visible if: com.unblu.conversation.concierge.conciergeHandleVisitorOnboarding=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

In this case no topic is set for the conversation

Conversation configuration

Allowed custom actions

com.unblu.conversation.availableCustomActionIds

  • Type: List of entity references

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Only custom action whose IDs are listed here are enabled for this conversation

Enable all custom actions

com.unblu.conversation.enableAllCustomActions

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable all available custom actions. This overrides the configuration property availableCustomActionIds.

Allow group conversation

com.unblu.conversation.groupConversation

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether the conversation is a group conversation or a private one

Allow changing conversation language

com.unblu.conversation.message.allowChangeConversationLanguage

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to change the language of a conversation

Allow changing scheduled time

com.unblu.conversation.message.allowChangeConversationScheduledTime

Only visible if: com.unblu.messenger.scheduledConversationEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to change the scheduled time of a scheduled conversation

Allow changing conversation topic

com.unblu.conversation.message.allowChangeConversationTopic

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to change the topic of a conversation

Allow non-admin users to change scheduled time using Web API

com.unblu.conversation.message.allowNonAdminUsersChangeConversationScheduledTimeViaWebApi

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

This configuration overrides the permission to change the scheduled time of a scheduled conversation

Allow non-admin users to change conversation topic using web API

com.unblu.conversation.message.allowNonAdminUsersChangeConversationTopicViaWebApi

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

This configuration overrides the permission to change the conversation topic

Conversation features

Enable audio and video calls

com.unblu.conversation.feature.callEnabled

Only visible if: com.unblu.messenger.callEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable context migration co-browsing

com.unblu.conversation.feature.contextMigrationCoBrowsingEnabled

Only visible if: com.unblu.messenger.contextMigrationCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable document co-browsing

com.unblu.conversation.feature.documentCoBrowsingEnabled

Only visible if: com.unblu.messenger.documentCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable embedded co-browsing

com.unblu.conversation.feature.embeddedCoBrowsingEnabled

Only visible if: com.unblu.messenger.embeddedCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable file sharing

com.unblu.conversation.feature.fileSharingEnabled

Only visible if: com.unblu.messenger.fileSharingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable mobile co-browsing

com.unblu.conversation.feature.mobileCoBrowsingEnabled

Only visible if: com.unblu.messenger.mobileCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable screen sharing

com.unblu.conversation.feature.screenSharingEnabled

Only visible if: com.unblu.messenger.screenSharingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants for whom screen sharing is enabled

com.unblu.conversation.feature.screenSharingEnabledPerActor

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Screen sharing in general must be enabled for the configuration property to have an effect

Enable text chat

com.unblu.conversation.feature.textChatEnabled

Only visible if: com.unblu.messenger.textChatEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable universal co-browsing

com.unblu.conversation.feature.universalCoBrowsingEnabled

Only visible if: com.unblu.messenger.universalCoBrowsingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable whiteboard

com.unblu.conversation.feature.whiteboardEnabled

Only visible if: com.unblu.messenger.whiteboardEnabled=true, com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversation file configuration

The participants allowed to launch file co-browsing

com.unblu.conversation.file.allowFileCobrowsing

Only visible if: com.unblu.conversation.feature.documentCoBrowsingEnabled=true, com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to initiate file co-browsing

The participants allowed to delete files

com.unblu.conversation.file.allowFileDeletion

Only visible if: com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to delete files uploaded to a conversation

The participants allowed to download files

com.unblu.conversation.file.allowFileDownload

Only visible if: com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Particpants allowed to download files

File upload allowed

com.unblu.conversation.file.allowFileUpload

Only visible if: com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to upload files

File upload allowed during offboarding

com.unblu.conversation.file.allowFileUploadDuringOffboarding

Only visible if: com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to upload a file during their offboarding process

File upload allowed during onboarding

com.unblu.conversation.file.allowFileUploadDuringOnboarding

Only visible if: com.unblu.conversation.feature.fileSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to upload a file during their onboarding process

Conversation universal co-browsing configuration

Enable co-browsing of links posted in chat

com.unblu.conversation.allowCobrowseLinksInUniversalCobrowsing

Only visible if: com.unblu.conversation.feature.universalCoBrowsingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants allowed to co-browse links posted in the chat in universal co-browsing

Default location for replacement of last window

com.unblu.conversation.headless-browser.defaultLastWindowReplacementLocation

  • Type: String

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Default location for the tab that replaces the last window

Default new window location

com.unblu.conversation.headless-browser.defaultNewWindowLocation

  • Type: String

  • Default: about:unblu.universal-cobrowsing

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Default location for new tabs

Default screen height

com.unblu.conversation.headless-browser.defaultScreenHeight

  • Type: Integer

  • Default: 768

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines the default screen height of a co-browsing window

Default screen width

com.unblu.conversation.headless-browser.defaultScreenWidth

  • Type: Integer

  • Default: 1360

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines the default screen width of a co-browsing window

Maximum screen height

com.unblu.conversation.headless-browser.maximalScreenHeight

  • Type: Integer

  • Default: 1080

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines the maximal screen height of a co-browsing window

Maximum co-browsing screen width

com.unblu.conversation.headless-browser.maximalScreenWidth

  • Type: Integer

  • Default: 1920

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Specify the maximum screen width of a co-browsing window

Maximum number of windows

com.unblu.conversation.headless-browser.maximalWindowCount

  • Type: Integer

  • Default: 5

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines how many tabs can be opened within a co-browsing session

Minimal screen height

com.unblu.conversation.headless-browser.minimalScreenHeight

  • Type: Integer

  • Default: 480

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines the minimal screen height of a co-browsing window

Minimal screen width

com.unblu.conversation.headless-browser.minimalScreenWidth

  • Type: Integer

  • Default: 320

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Determines the maximal screen width of a co-browsing window

Replace last window

com.unblu.conversation.headless-browser.replaceLastWindow

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether the rendering service should automatically open a new window when the last tab is closed

Conversation invitations

Agent invitation visibility options

com.unblu.conversation.invitation.agentInvitationVisiblityOption

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: String with allowed values:

    • hidden

    • visible

    • visible_and_hidden

  • Default: VISIBLE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Lets agents invite other agents as visible or hidden participants

Allow assigned agent to set new assigned agent

com.unblu.conversation.invitation.allowAssigneeToSetNewAssignee

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to forward to agent

com.unblu.conversation.invitation.allowForwardToAgent

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to forward to named area

com.unblu.conversation.invitation.allowForwardToNamedArea

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to forward to team

com.unblu.conversation.invitation.allowForwardToTeam

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to invite agents

com.unblu.conversation.invitation.allowInviteAgent

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to invite teams

com.unblu.conversation.invitation.allowInviteTeam

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to invite visitors

com.unblu.conversation.invitation.allowInviteVisitor

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to invite visitors by email

com.unblu.conversation.invitation.allowInviteVisitorEmail

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Only relevant for roles generally allowed to invite visitors; see com.unblu.conversation.invitation.allowInviteVisitor

Participants allowed to invite visitors with PIN

com.unblu.conversation.invitation.allowInviteVisitorPin

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Only relevant for roles generally allowed to invite visitors; see com.unblu.conversation.invitation.allowInviteVisitor

com.unblu.conversation.invitation.allowInviteVisitorPrivateLink

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Only relevant for roles generally allowed to invite visitors; see com.unblu.conversation.invitation.allowInviteVisitor

Allow access via public link

com.unblu.conversation.invitation.allowPublicLinkAccess

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow secondary agents to set new assigned agent

com.unblu.conversation.invitation.allowSecondaryAgentsToSetNewAssignee

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversation request queue sorting order

com.unblu.conversation.invitation.conversationRequestQueueSortingOrder

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify the ranking a conversation should have if it is added to the queue by an invitation of the type CONVERSATION_REQUEST. Conversations with a lower order number are given higher ranking and will be dispatched first. If two conversations have the same order number, the invitation’s creation date will be used to determine the conversations' ranking. A CONVERSATION_REQUEST invitation can be triggered by a visitor starting a conversation, by re-queueing a conversation, or by forwarding a conversation to a named area.

Enable deputy delegation

com.unblu.conversation.invitation.enableDeputyDelegation

Only visible if: com.unblu.messenger.enableDeputyDelegation=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversations are only delegated to a deputy if the original recipient of the conversation was an agent

Level 1 escalation timeout (in s)

com.unblu.conversation.invitation.level1EscalationTimeoutSeconds

Only visible if: com.unblu.conversation.invitation.enableDeputyDelegation=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time in seconds an agent has to accept a conversation. If they don’t accept the conversation within this period, their level 1 deputies are contacted and asked to handle the conversation request.

Level 2 escalation timeout (in s)

com.unblu.conversation.invitation.level2EscalationTimeoutSeconds

Only visible if: com.unblu.conversation.invitation.enableDeputyDelegation=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time in seconds for level 1 deputies to accept a conversation delegated to them. If no level 1 deputy accepts the conversation within this period, the original recipient’s level 2 deputies are contacted and asked to handle the conversation request.

Level 3 escalation timeout (in s)

com.unblu.conversation.invitation.level3EscalationTimeoutSeconds

Only visible if: com.unblu.conversation.invitation.enableDeputyDelegation=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time in seconds for level 2 deputies to accept a conversation delegated to them. If no level 2 deputy accepts the conversation within this period, the original recipient’s level 3 deputies are contacted and asked to handle the conversation request.

Require agent approval for visitors joining with public link

com.unblu.conversation.invitation.requireAgentApprovalBeforeJoin

Only visible if: com.unblu.conversation.invitation.allowPublicLinkAccess=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Require agent approval for agents joining with public link

com.unblu.conversation.invitation.requireAgentApprovalBeforeJoinAsAgent

Only visible if: com.unblu.conversation.invitation.allowPublicLinkAccess=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether an agent’s approval is required before another agent may join a conversation via a public link

Forwarding targets that set the conversation’s recipient

com.unblu.conversation.invitation.setRecipientForForwardingTargets

  • Type: List of string with allowed values:s

    • agent

    • named_area

    • team

  • Default: AGENT,TEAM,NAMED_AREA

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

When enabled, forwarding a conversation automatically sets the forwarding target as the recipient of the conversation, as well as generating an invitation

Show empty teams in invitation and forwarding UIs

com.unblu.conversation.invitation.showEmptyTeamsWhenForwardingAndInviting

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Team invitation visibility options

com.unblu.conversation.invitation.teamInvitationVisiblityOption

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: String with allowed values:

    • hidden

    • visible

    • visible_and_hidden

  • Default: VISIBLE

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Lets agents invite teams as visible or hidden participants

Unanswered escalation timeout (in s)

com.unblu.conversation.invitation.unansweredEscalationTimeoutSeconds

Only visible if: com.unblu.conversation.invitation.enableDeputyDelegation=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time in seconds for level 3 deputies to accept a conversation delegated to them. If no level 3 deputy accepts the conversation within this period, the conversation request is marked as unanswered and Unblu sends out a webhook that no-one in the deputy delegation chain accepted the conversation request.

Visitor Desk API key ID

com.unblu.conversation.invitation.visitorDeskApiKeyId

  • Type: Entity reference

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Used when creating Visitor Desk URLs

Make email invitee’s name mandatory

com.unblu.conversation.invitation.visitorEmailInviteeMandatory

  • Type: String with allowed values:

    • mandatory

    • none

    • optional

  • Default: OPTIONAL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Make PIN invitee’s name mandatory

com.unblu.conversation.invitation.visitorPinInviteeMandatory

  • Type: String with allowed values:

    • mandatory

    • none

    • optional

  • Default: OPTIONAL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Make private link invitee’s name mandatory

com.unblu.conversation.invitation.visitorPrivateLinkInviteeMandatory

  • Type: String with allowed values:

    • mandatory

    • none

    • optional

  • Default: OPTIONAL

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversation lifecycle

Allow assigned agent to change participation visibility

com.unblu.conversation.lifecycle.allowAssignedAgentToChangeParticipationVisibilities

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to end conversation

com.unblu.conversation.lifecycle.allowEnd

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to end conversation during onboarding

com.unblu.conversation.lifecycle.allowEndDuringOnboarding

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow ghost participants

com.unblu.conversation.lifecycle.allowGhostToJoin

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to leave conversation

com.unblu.conversation.lifecycle.allowLeave

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow secondary agents to change visibility

com.unblu.conversation.lifecycle.allowSecondaryAgentsToChangeVisibility

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Auto-end conversation when call ends

com.unblu.conversation.lifecycle.autoEndOnCallEnd

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Auto-end conversation on disconnect

com.unblu.conversation.lifecycle.autoEndOnDisconnect

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants who automatically end the conversation when they disconnect

Auto-end conversation on leave

com.unblu.conversation.lifecycle.autoEndOnLeave

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants who automatically end the conversation when they leave

Automaticlally leave conversation on disconnect

com.unblu.conversation.lifecycle.autoLeaveOnDisconnect

Only visible if: com.unblu.conversation.groupConversation=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants who automatically leave the conversation when they lose their connection

Auto-start scheduled conversations

com.unblu.conversation.lifecycle.autoStartScheduledConversation

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If active, scheduled conversations start automatically once the assigned agent joins

Migration message acknowledgment time

com.unblu.conversation.lifecycle.conversationBoardingMigrationAckMessageTime

  • Type: Integer

  • Default: 30

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The number of seconds to display a message to the participant of a boarding process informing them that the process will be migrated to a new node before the collaboration server is shut down

Timeout for conversation offboarding — ending conversation

com.unblu.conversation.lifecycle.conversationOffboardingTimeoutConversationEnded

  • Type: Integer

  • Default: 300

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in seconds, that unblu waits for each user to finish their offboarding process before the conversation is automatically ended

Timeout for participation removal during offboarding

com.unblu.conversation.lifecycle.conversationOffboardingTimeoutOther

  • Type: Integer

  • Default: 30

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time, in seconds, for the user to finish the offboarding process before their participation is automatically removed. This timeout applies in all use cases except when the user leaves the conversation themselves.

Timeout for conversation offboarding before participation removal on manual leave

com.unblu.conversation.lifecycle.conversationOffboardingTimeoutPersonLeft

  • Type: Integer

  • Default: 300

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time, in seconds, that Unblu waits for the user to finish the offboarding process before their participation is automatically removed when a person manually leaves

Conversation onboarding timeout (in s)

com.unblu.conversation.lifecycle.conversationOnboardingTimeout

  • Type: Integer

  • Default: 600

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time, in seconds, for the user to complete the onboarding process. If the timeout is reached, the conversation is treated as idle and the conversation is handed off to the next bot or agent, or canceled if the bot’s successful completion is required for the onboarding process to proceed.

Reboarding timeout

com.unblu.conversation.lifecycle.conversationReboardingTimeout

  • Type: Integer

  • Default: 600

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time, in seconds, for the user to complete the reboarding process. If the timeout is reached, the bot is treated as idle and the conversation is handed off to the next bot or agent. If the bot’s participation is required by the reboarding process, the conversation is returned to the "unassigned" state.

Enable "unassigned" state

com.unblu.conversation.lifecycle.enableUnassignedState

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether a conversation should go to the "unassigned" state when the assigned agent leaves the conversation or when a bot solves the visitor’s issue. Enabling the feature allows the conversation to be re-queued if the visitor enters a new message. If disabled, the conversation ends in the aforementioned cases.

Replace user on login

com.unblu.conversation.lifecycle.replaceUserOnLogin

  • Type: String with allowed values:

    • always

    • if_active_conversation

    • never

  • Default: NEVER

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

When to replace the user on login. If enabled and a corresponding login takes place, then the anonymous person is replaced by the authenticated person (within the conversation) on login.

Show "change nickname" action in agents' overview action bar

com.unblu.conversation.ui.allowChangeAnonymousVisitorNickname

  • Type: List of string with allowed values:s

    • assigned_agent

    • ghost

    • recorder

    • secondary_agent

  • Default: ASSIGNED_AGENT,SECONDARY_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The action lets agents change the nickname of anonymous visitors in a conversation

Participants allowed to remove other participants

com.unblu.conversation.ui.removeParticipant

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversation messages

Allow chat during offboarding

com.unblu.conversation.message.allowChatDuringOffboarding

Only visible if: com.unblu.conversation.feature.textChatEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to write messages during offboarding process

Allow chat during onboarding

com.unblu.conversation.message.allowChatDuringOnboarding

Only visible if: com.unblu.conversation.feature.textChatEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: []

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to write chat messages during onboarding process

Allow exporting message log

com.unblu.conversation.message.allowExportMessageLog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to download/export the message log as a CSV file

Participants allowed to see all bot thread messages

com.unblu.conversation.message.allowSeeAllBotThreadMessages

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants can see all messages that belong to a bot thread, even if the bot thread is not their own

Allow seeing general system messages for agent invitation

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForAgentInvitation

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category AGENT_INVITATION

Allow seeing general system messages for assignment requests

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForAssignmentRequest

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category ASSIGNMENT_REQUEST

Allow seeing general system messages for call dial-in

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCallDialIn

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CALL_DIAL_IN

Allow seeing general system messages for call lifecycle

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCallLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CALL_LIFECYCLE

Allow seeing general system messages for call participant

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCallParticipant

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CALL_PARTICIPANT

Allow seeing general system messages for call participant publishing state

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCallParticipantPublishingState

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CALL_PARTICIPANT_PUBLISHING_STATE

Allow seeing general system messages for call snapshots

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCallSnapshot

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CALL_SNAPSHOT

Allow seeing general system messages for conversation admission

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForConversationAdmission

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CONVERSATION_ADMISSION

Allow seeing general system messages for conversation internal properties

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForConversationInternalProperties

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CONVERSATION_INTERNAL_PROPERTIES

Allow seeing general system messages for conversation properties

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForConversationProperties

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CONVERSATION_PROPERTIES

Allow seeing general system messages for custom actions

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForCustomActions

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CUSTOM_ACTION

Allow seeing general system messages for forwarding

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForForwarding

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category FORWARDING

Allow seeing general system messages for forwarding state

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForForwardingState

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category FORWARDING_STATE

Allow seeing general system messages for imminent shutdown

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForImminentShutdown

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category IMMINENT_SHUTDOWN

Allow seeing general system messages for layer action "control"

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForLayerActionControl

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category LAYER_ACTION_CONTROL

Allow seeing general system messages for layer action "sharing pause"

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForLayerActionSharingPause

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category LAYER_ACTION_SHARING_PAUSE

Allow seeing general system messages for layer inactivity

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForLayerInactivity

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category LAYER_INACTIVITY

Allow seeing general system messages for layer lifecycle

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForLayerLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category LAYER_LIFECYCLE

Allow seeing general system messages for participation joining

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForParticipantJoined

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category PARTICIPATION_JOINED

Allow seeing general system messages for participant left reason

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForParticipantLeftReason

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category PARTICIPATION_LEFT_REASON

Allow seeing general system messages for participation role change

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForParticipantRoleChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category PARTICIPATION_ROLE_CHANGE

Allow seeing general system messages for participation visibility change

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForParticipantVisibilityChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category PARTICIPANT_VISIBILITY_CHANGE

Allow seeing general system messages for terminating instances

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForTerminatingInstances

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category TERMINATING_INSTANCES

Allow seeing general system messages for user change

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForUserChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category USER_CHANGE

Allow seeing general system messages for visitor invitations

com.unblu.conversation.message.allowSeeGeneralSystemMessagesForVisitorInvitation

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category VISITOR_INVITATION

Allow seeing internal messages

com.unblu.conversation.message.allowSeeInternalMessages

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • recorder

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST,RECORDER

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see conversation internal messages

Allow seeing message recipients

com.unblu.conversation.message.allowSeeMessageRecipient

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see conversation message recipients

Allow seeing message status

com.unblu.conversation.message.allowSeeMessageStatus

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see conversation message status

Participants allowed to see messages for other recipients

com.unblu.conversation.message.allowSeeMessagesForOtherRecipients

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Doesn’t include messages in bot threads

Allow seeing personal system messages for agent invitation

com.unblu.conversation.message.allowSeePersonalSystemMessagesForAgentInvitation

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category AGENT_INVITATION

Allow seeing personal system messages for assignment requests

com.unblu.conversation.message.allowSeePersonalSystemMessagesForAssignmentRequest

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category ASSIGNMENT_REQUEST

Allow seeing personal system messages for call dial-in

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCallDialIn

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CALL_DIAL_IN

Allow seeing personal system messages for call lifecycle

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCallLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CALL_LIFECYCLE

Allow seeing personal system messages for call participant

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCallParticipant

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CALL_PARTICIPANT

Allow seeing personal system messages for call participant publishing state

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCallParticipantPublishingState

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CALL_PARTICIPANT_PUBLISHING_STATE

Allow seeing personal system messages for call snapshots

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCallSnapshot

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CALL_SNAPSHOT

Allow seeing personal system messages for conversation admission

com.unblu.conversation.message.allowSeePersonalSystemMessagesForConversationAdmission

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CONVERSATION_ADMISSION

Allow seeing personal system messages for conversation internal properties

com.unblu.conversation.message.allowSeePersonalSystemMessagesForConversationInternalProperties

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CONVERSATION_INTERNAL_PROPERTIES

Allow seeing personal system messages for conversation properties

com.unblu.conversation.message.allowSeePersonalSystemMessagesForConversationProperties

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CONVERSATION_PROPERTIES

Allow seeing personal system messages for custom actions

com.unblu.conversation.message.allowSeePersonalSystemMessagesForCustomActions

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category CUSTOM_ACTION

Allow seeing personal system messages for forwarding

com.unblu.conversation.message.allowSeePersonalSystemMessagesForForwarding

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category FORWARDING

Allow seeing personal system messages for forwarding state

com.unblu.conversation.message.allowSeePersonalSystemMessagesForForwardingState

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category FORWARDING_STATE

Allow seeing personal system messages for layer action "control"

com.unblu.conversation.message.allowSeePersonalSystemMessagesForLayerActionControl

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category LAYER_ACTION_CONTROL

Allow seeing personal system messages for layer action "sharing pause"

com.unblu.conversation.message.allowSeePersonalSystemMessagesForLayerActionSharingPause

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category LAYER_ACTION_SHARING_PAUSE

Allow seeing personal system messages for layer inactivity

com.unblu.conversation.message.allowSeePersonalSystemMessagesForLayerInactivity

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category LAYER_INACTIVITY

Allow seeing personal system messages for layer lifecycle

com.unblu.conversation.message.allowSeePersonalSystemMessagesForLayerLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category LAYER_LIFECYCLE

Allow seeing personal system messages for participation joining

com.unblu.conversation.message.allowSeePersonalSystemMessagesForParticipantJoined

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category PARTICIPATION_JOINED

Allow seeing personal system messages for participant left reason

com.unblu.conversation.message.allowSeePersonalSystemMessagesForParticipantLeftReason

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category PARTICIPATION_LEFT_REASON

Allow seeing personal system messages for participation role change

com.unblu.conversation.message.allowSeePersonalSystemMessagesForParticipantRoleChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages in the category PARTICIPATION_ROLE_CHANGE related to them

Allow seeing personal system messages for participation visibility change

com.unblu.conversation.message.allowSeePersonalSystemMessagesForParticipantVisibilityChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category PARTICIPANT_VISIBILITY_CHANGE

Allow seeing personal system messages for terminating instances

com.unblu.conversation.message.allowSeePersonalSystemMessagesForTerminatingInstances

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category TERMINATING_INSTANCES

Allow seeing personal system messages for user change

com.unblu.conversation.message.allowSeePersonalSystemMessagesForUserChange

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see personal system messages related to them in them category USER_CHANGE

Allow seeing personal system messages for visitor invitations

com.unblu.conversation.message.allowSeePersonalSystemMessagesForVisitorInvitation

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see system messages related to them personally in the category VISITOR_INVITATION

Allow seeing general system messages for conversation end reason

com.unblu.conversation.message.allowSeeSystemMessagesForConversationEndReason

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CONVERSATION_END_REASON

Allow seeing general system messages for conversation lifecycle

com.unblu.conversation.message.allowSeeSystemMessagesForConversationLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category CONVERSATION_LIFEFCYCLE

Allow seeing general system messages for recording lifecycle

com.unblu.conversation.message.allowSeeSystemMessagesForRecordingLifecycle

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages in the category RECORDING_LIFEFCYCLE

Allow seeing typing indicator

com.unblu.conversation.message.allowSeeTypingIndicator

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The typing indicator informs participants listed in this configuration property that another participant is typing a message

Chat message character limit

com.unblu.conversation.message.chatTextInputMaxLength

  • Type: Integer

  • Default: 5000

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum number of characters in a single chat message

When to mark agent messages as read

com.unblu.conversation.message.markAgentMessagesAsReadCondition

  • Type: String with allowed values:

    • read_by_all_excluding_hidden

    • read_by_all_visitors

    • read_by_any_visitor

    • read_by_context_person

  • Default: READ_BY_ALL_EXCLUDING_HIDDEN

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

When to mark visitor messages as read

com.unblu.conversation.message.markVisitorMessagesAsReadCondition

  • Type: String with allowed values:

    • read_by_all_agents_excluding_hidden

    • read_by_all_excluding_hidden

    • read_by_any_agent_excluding_hidden

    • read_by_any_agent_including_hidden

    • read_by_assignee

  • Default: READ_BY_ALL_EXCLUDING_HIDDEN

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow replying to individual messages

com.unblu.conversation.message.replyToMessages

Only visible if: com.unblu.conversation.feature.textChatEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to reply to individual chat messages

Allow sending internal messages

com.unblu.conversation.message.sendInternalMessages

Only visible if: com.unblu.conversation.feature.textChatEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • secondary_agent

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to send internal chat messages

Allow sending public messages

com.unblu.conversation.message.sendPublicMessages

Only visible if: com.unblu.conversation.feature.textChatEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to send public chat messages

Enable Markdown for chat message input

com.unblu.conversation.messaging.ui.chatMessageAsMarkdownEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

If enabled, the content of chat messages entered in the UI’s text input field is interpreted as Markdown. For other message types, such as those from dialog bots, Markdown formatting is applied according to their respective configuration, independently of this setting. Warning: While this configuration property can also be set in the scopes "API key" and "named area", the Unblu server only takes the "user", "team" and "account" scopes into account. If not enabled for the sender of the message in one of these scopes, the Unblu server coerces the message to the text type "simple text".

Allow seeing general system messages for recording availability

com.unblu.conversation.recording.allowSeeRecordingAvailableMessages

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants allowed to see general system messages indicating that there is a recording available. The system message includes a video frame of the recording.

Conversation message interceptors configuration

Enable all message interceptors

com.unblu.conversation.message_interceptor.enableAllMessageInterceptors

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable all message interceptors in this conversation. This overrides the configuration property messageInterceptorIds.

Interceptor timeout (in ms)

com.unblu.conversation.message_interceptor.maxInterceptionTime

  • Type: Integer

  • Default: 4000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum time in milliseconds that an interceptor has to respond. If the time is reached, the intercepted message is rejected.

Message interceptors

com.unblu.conversation.message_interceptor.messageInterceptorIds

  • Type: List of entity references

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The list of message interceptors you want to enable in this conversation. If enableAllMessageInterceptors is set to true, this list is ignored.

Timeout severity

com.unblu.conversation.message_interceptor.timeoutSeverity

  • Type: String with allowed values:

    • high

    • low

    • medium

  • Default: HIGH

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The severity assigned to messages timing out when intercepted

Conversation pop-out configuration

Enable pop-out feature

com.unblu.conversation.popout.popoutEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable the pop-out feature

Activate pop-out in calls

com.unblu.conversation.popout.popoutOnCall

Only visible if: com.unblu.conversation.popout.popoutEnabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether to pop out the UI in calls

Conversation recording

Allow closing recording banner

com.unblu.conversation.recording.allowCloseRecordingBanner

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Allow start/stop manual recording

com.unblu.conversation.recording.allowManualRecording

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • secondary_agent

  • Default: ASSIGNED_AGENT,SECONDARY_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Which participants may start and stop recording. recordingTriggeringMode must be set to manual for this setting to have an effect

Store recording data in DB temporarily during upload

com.unblu.conversation.recording.backupUnfinishedInDbWhileUploading

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Temporarily store data in the database during upload to external storage such as GCS or S3 to improve resilience

Enable recording banner

com.unblu.conversation.recording.enableRecordingBanner

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Display a banner while recording a conversation

Conversation recording initialization timeout (in s)

com.unblu.conversation.recording.initializationTimeout

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Integer

  • Default: 10

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time, in seconds, for the initialization phase to be completed before an error is raised

Recorded content

com.unblu.conversation.recording.recordedContent

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: List of string with allowed values:s

    • call

    • chat

    • collaboration_layer

  • Default: CALL,CHAT,COLLABORATION_LAYER

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If the recording mode is AUDIO_ONLY, no content from the conversation will be recorded except audio

Conversation Recording API key ID

com.unblu.conversation.recording.recordingApiKeyId

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Entity reference

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Used when creating the conversation recording URL accessed by the Rendering Service

Enable conversation recording

com.unblu.conversation.recording.recordingEnabled

Only visible if: com.unblu.messenger.recordingEnabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Conversation recording failover mode

com.unblu.conversation.recording.recordingFailoverMode

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String with allowed values:

    • abort

    • retry

  • Default: RETRY

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

RETRY will start a new recording for the ongoing collaboration if an error occurs. ABORT will stop the recording and all recorded sources (call & collaboration layers).

Recording filename pattern

com.unblu.conversation.recording.recordingFilenamePattern

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String

  • Default: conversation-recording-${creationTime}

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The file extension for the MPEG-4 MIME type is automatically appended when the file is created. ${creationTime} is a placeholder for the UTC start time of the recording.

Recording height (in px)

com.unblu.conversation.recording.recordingHeight

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Integer

  • Default: 1080

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The minimum supported height is 600 pixels, the maximum height is 2160 pixels. Only applies if the recording mode is AUDIO_VIDEO.

Maximum number of recording retries

com.unblu.conversation.recording.recordingMaxRetries

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Integer

  • Default: 3

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Specify the maximum number of retries to start a conversation recording before either allowing the audio visual content to start anyway or aborting it, depending on the configured value of the recording failover mode

Maximum retry delay (in s)

com.unblu.conversation.recording.recordingMaxRetryDelay

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Integer

  • Default: 60

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum exponential backoff delay, in seconds, for retrying a failed conversation recording

Recording mode

com.unblu.conversation.recording.recordingMode

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String with allowed values:

    • audio_only

    • audio_video

  • Default: AUDIO_VIDEO

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The recording mode for conversation recording. You can record audio and video or only audio.

Conversation recording start mode

com.unblu.conversation.recording.recordingStartMode

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String with allowed values:

    • asynchronous

    • synchronous

  • Default: SYNCHRONOUS

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

In ASYNCHRONOUS mode, the first couple of seconds of an interaction may not be recorded, but it ensures that the UX is not impacted by a delay in recording. In SYNCHRONOUS mode, recorded sources (calls & collaboration layers) only start once the recording is ready, unless you have set the failover mode to RETRY. If an error occurs during recording, all recorded sources are stopped automatically.

Recording time format

com.unblu.conversation.recording.recordingTimeFormat

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String

  • Default: yyyy-MM-dd’T’HH:mm:ssZ

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Java DateTime compatible format used for recording times

recordingTriggeringMode

com.unblu.conversation.recording.recordingTriggeringMode

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: String with allowed values:

    • automatic

    • manual

  • Default: AUTOMATIC

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The recording mode can be either automatic, based on layers or a call starting, or managed manually, using the UI or API

Sources that trigger conversation recording

com.unblu.conversation.recording.recordingTriggeringSources

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: List of string with allowed values:s

    • call

    • collaboration_layer

  • Default: CALL, COLLABORATION_LAYER

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

If the recording mode is AUDIO_ONLY, the only valid triggering source is CALL

Recording width (in px)

com.unblu.conversation.recording.recordingWidth

Only visible if: com.unblu.conversation.recording.recordingEnabled=true

  • Type: Integer

  • Default: 1920

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The minimum supported width is 800 pixels, the maximum width is 3840 pixels. Only applies if the recording mode is AUDIO_VIDEO.

Screen sharing configuration

Allow sharing audio

com.unblu.conversation.allowSharingAudio

Only visible if: com.unblu.conversation.feature.screenSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants allowed to share audio along with their screen. Note that not all browsers support this feature.

Allow sharing entire screen

com.unblu.conversation.allowSharingEntireScreen

Only visible if: com.unblu.conversation.feature.screenSharingEnabled=true

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The participants allowed to share the displaySurface "monitor" in addition to "window" and "browser" (see https://developer.mozilla.org/en-US/docs/Web/API/MediaTrackSettings/displaySurface for more information). This can be disabled for security reasons. Note: If the browser of a participant does not support displaySurface, the screen sharing feature will be disabled unless they are listed in this property.

Conversation UI configuration

Close UI for assigned agent when conversation is ended

com.unblu.conversation.ui.autoCloseOnConversationEndForAssignedAgent

  • Type: String with allowed values:

    • by_anyone

    • by_me

    • never

  • Default: BY_ME

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify when the conversation UI should be closed automatically for the assigned agent at the end of a conversation. Possible values are: NEVER (never close the participant’s UI automatically), BY_ME (close the participant’s UI, if he/she ended the conversation) and BY_ANYONE (close the participant’s UI, regardless of who ended the conversation).

Close UI for context person when conversation is ended

com.unblu.conversation.ui.autoCloseOnConversationEndForContextPerson

  • Type: String with allowed values:

    • by_anyone

    • by_me

    • never

  • Default: BY_ME

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify when the conversation UI should be closed automatically for the context person at the end of a conversation. Possible values are: NEVER (never close the participant’s UI automatically), BY_ME (close the participant’s UI, if he/she ended the conversation) and BY_ANYONE (close the participant’s UI, regardless of who ended the conversation).

Close UI for secondary agent when conversation is ended

com.unblu.conversation.ui.autoCloseOnConversationEndForSecondaryAgent

  • Type: String with allowed values:

    • by_anyone

    • by_me

    • never

  • Default: BY_ME

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify when the conversation UI should be closed automatically for the secondary agent at the end of a conversation. Possible values are: NEVER (never close the participant’s UI automatically), BY_ME (close the participant’s UI if they ended the conversation) and BY_ANYONE (close the participant’s UI, regardless of who ended the conversation).

Close UI for secondary visitor when conversation is ended

com.unblu.conversation.ui.autoCloseOnConversationEndForSecondaryVisitor

  • Type: String with allowed values:

    • by_anyone

    • by_me

    • never

  • Default: BY_ME

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify when the conversation UI should be closed automatically for the secondary visitor at the end of a conversation. Possible values are: NEVER (never close the participant’s UI automatically), BY_ME (close the participant’s UI, if he/she ended the conversation) and BY_ANYONE (close the participant’s UI, regardless of who ended the conversation).

Auto-collapse chat when a collaboration layer is activated

com.unblu.conversation.ui.autoCollapseIndividualUiOnLayerActivation

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Specify whether the visitor floating UI and agent chat panel should be collapsed automatically when a collaboration layer such as co-browsing is activated

Display info button in agent conversation bar

com.unblu.conversation.ui.showDetailsInAgentConversationBar

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Display the "info" button on the agent conversation bar

Show confirmation dialog if conversation ended by user

com.unblu.conversation.ui.showEndConversationConfirmationDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Hidden agent visibility

com.unblu.conversation.ui.showHiddenAgents

  • Type: List of string with allowed values:s

    • assigned_agent

    • ghost

    • recorder

    • secondary_agent

  • Default: ASSIGNED_AGENT,SECONDARY_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Which participant types may see hidden agents

Show confirmation dialog if participant leaves conversation

com.unblu.conversation.ui.showLeaveConversationConfirmationDialog

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Leave conversation button in Agent Desk

com.unblu.conversation.ui.showLeaveInAgentControlBar

  • Type: Boolean

  • Default: false

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Show a button in the Agent Desk to leave the conversation. The setting is ignored if the agent has no permission to leave a conversation. See conversation.lifecycle.allowLeave.

Show person details

com.unblu.conversation.ui.showPersonDetails

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: SECONDARY_AGENT,ASSIGNED_AGENT,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Define which participant types may see person details such as email addresses and telephone numbers

showTextMessageCopyButton

com.unblu.conversation.ui.showTextMessageCopyButton

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • ghost

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR,GHOST

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Display the copy action on text messages

Revoke granted permissions at the conversation level

Revoke "enable camera in call" permission

com.unblu.conversation.user.revoke.revokeEnableCameraInCall

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to enable the camera in a call

Revoke "layers control" permission

com.unblu.conversation.user.revoke.revokeEnableLayersControl

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to start any collaboration layer in a conversation

Revoke "write chat" permission

com.unblu.conversation.user.revoke.revokeEnableWriteChat

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to write chat messages in a conversation

Revoke "upload and share files" permission

com.unblu.conversation.user.revoke.revokeFileUploadAndSharing

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to upload and share files in a conversation

Revoke "provide embedded co-browsing" permission

com.unblu.conversation.user.revoke.revokeProvideEmbeddedCoBrowsing

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the possibility to provide embedded co-browsing in a conversation. When this permission is revoked, users can neither start embedded co-browsing in their tab nor be asked to do so by another participant.

Revoke "provide mobile co-browsing" permission

com.unblu.conversation.user.revoke.revokeProvideMobileCoBrowsing

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the mobile co-browsing permission in a conversation. When this permission is revoked, users can neither start a mobile co-browsing session in their app nor be asked to do so by another participant.

Revoke "share own screen" permission

com.unblu.conversation.user.revoke.revokeShareOwnScreen

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the screen sharing permission in a conversation. When this permission is revoked, users can neither start sharing their screen nor be asked to do so by another participant.

Revoke "start audio call" permission

com.unblu.conversation.user.revoke.revokeStartAudioCall

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to start an audio call in a conversation. Users can still join an audio call initiated by somebody else.

Revoke "start video call" permission

com.unblu.conversation.user.revoke.revokeStartVideoCall

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Revoke the permission to start a video call in a conversation. Users can still join a video call initiated by somebody else.

Conversation notification configuration

Assigned agent notification rule

com.unblu.conversation.notification.assignedAgentNotificationRule

  • Type: String with allowed values:

    • never

    • unread_by_all_agents_excluding_hidden

    • unread_by_all_agents_including_hidden

    • unread_by_person_to_notify

  • Default: UNREAD_BY_PERSON_TO_NOTIFY

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The rule specifying when to notify the assigned agent of unread messages in a conversation

Context person notification rule

com.unblu.conversation.notification.contextPersonNotificationRule

  • Type: String with allowed values:

    • never

    • unread_by_person_to_notify

  • Default: UNREAD_BY_PERSON_TO_NOTIFY

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The rule specifying when to notify the context person of unread messages in a conversation

Participants to increment new message notification count for

com.unblu.conversation.notification.enableNotificationForBotMessages

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants for whom the new message notification count should increase when they receive a new bot message

The participants for whom push notifications should be enabled

com.unblu.conversation.notification.enablePushNotificationsPerActor

  • Type: List of string with allowed values:s

    • assigned_agent

    • context_person

    • secondary_agent

    • secondary_visitor

  • Default: ASSIGNED_AGENT,CONTEXT_PERSON,SECONDARY_AGENT,SECONDARY_VISITOR

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Participants who should receive push notifications. Push notifications must be active in general for this setting to have an effect.

Secondary agent notification rule

com.unblu.conversation.notification.secondaryAgentNotificationRule

  • Type: String with allowed values:

    • never

    • unread_by_all_agents_excluding_hidden

    • unread_by_all_agents_including_hidden

    • unread_by_assignee

    • unread_by_person_to_notify

  • Default: UNREAD_BY_PERSON_TO_NOTIFY

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The rule specifying when to notify secondary agents of unread messages in a conversation

Secondary visitor notification rule

com.unblu.conversation.notification.secondaryVisitorNotificationRule

  • Type: String with allowed values:

    • never

    • unread_by_person_to_notify

  • Default: UNREAD_BY_PERSON_TO_NOTIFY

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

The rule specifying when to notify a secondary visitor of unread messages in a conversation

Remote support action configuration

Click support enabled in embedded co-browsing

com.unblu.domcap.remoteaction.clickEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable support for click events in embedded co-browsing

Enable input change event support

com.unblu.domcap.remoteaction.inputChangeEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable support for input field change events in embedded co-browsing

Enable scroll event support

com.unblu.domcap.remoteaction.scrollEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable support for scroll events in embedded co-browsing

Enable SELECT element support

com.unblu.domcap.remoteaction.selectionEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: CONVERSATION, CONVERSATION_TEMPLATE

  • Visibility: PUBLIC

Enable support for HTML SELECT element change events in embedded co-browsing

Visitor presence configuration

Visitor presence initialization mode

com.unblu.visitor.presence.visitorPresenceInitializationMode

  • Type: String with allowed values:

    • always

    • in_conversation

    • on_interaction

  • Default: ALWAYS

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Specify when and how to initialize visitor sessions. This should almost always be set to ALWAYS. In IN_CONVERSATION mode, the visitor session will only be connected when a conversation is started by the visitor or the visitor JS API. Additionally, the online state of visitors cannot be tracked until they start a conversation. This mode must only be used in live support scenarios where only one conversation can be active at a time and past conversations are not visible to visitors. In ON_INTERACTION mode, the visitor session will only be started when the launcher button is clicked or the JS API triggers an upgrade to greedy.

only set this property to IN_CONVERSATION or ON_INTERACTION if you really know what you are doing! If one of these modes is selected, there will be no polling for new conversations, messages or incoming calls in the case of lazy site integration.

Visitor session configuration

Show ended call conversations

com.unblu.visitorsession.showEndedCallConversations

Only visible if: com.unblu.visitorsession.showEndedConversations=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List audio & video call conversations that have ended in the visitor conversation overview

Show ended conversations

com.unblu.visitorsession.showEndedConversations

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to display ended conversations in the visitor conversation overview

Show empty ended conversations

com.unblu.visitorsession.showEndedEmptyConversations

Only visible if: com.unblu.visitorsession.showEndedConversations=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Display conversations that have ended in the visitor conversation overview, even if they only contain system messages and no chat messages

Display ended PIN conversations

com.unblu.visitorsession.showEndedPinConversations

Only visible if: com.unblu.visitorsession.showEndedConversations=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to display ended PIN conversations in the visitor conversation overview

ClientCookieStrategyConfiguration

Time to live, in seconds, for the set cookie

com.unblu.cookiestrategy.cookieExpirationTime

  • Type: Integer

  • Default: 90

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

ConversationSessionCookieConfiguration

Name of the conversation session cookie

com.unblu.conversationsession.cookieName

  • Type: String

  • Default: ${cookieNamePrefix}-conversation-session

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Document co-browsing configuration

Base URL for online document viewer

com.unblu.hbworker.externalViewerBaseUrl

Base URL of the online viewer for office documents (Word, Excel, PowerPoint etc.)

Supported MIME types of online viewer

com.unblu.hbworker.externalViewerSupportedMimetypes

  • Type: List of strings

  • Default: text/plain,application/msword,application/vnd.openxmlformats-officedocument.wordprocessingml.document,application/vnd.ms-powerpoint,application/vnd.openxmlformats-officedocument.presentationml.presentation,application/vnd.ms-excel,application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MIME types supported by the online document viewer service

Google viewer token TTL

com.unblu.hbworker.externalViewerTokenTTL

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Time to live (TTL) in seconds of the token for the online document viewer to redeem. Used to secure the public file download for this case.

Enable google document viewing service

com.unblu.hbworker.useExternalDocViewer

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to enable the online document viewer for Word, Excel, PowerPoint documents etc.

GrafanaAnalyticsFeatureConfig

Grant non-admins access to analytics dashboards

com.unblu.analytics.grafana.allowAccessToAnalytics

Only visible if: com.unblu.analytics.grafana.enabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

If enabled, all analytics data is accessible without restriction to all agents and teams

Enable/disable analytics feature

com.unblu.analytics.grafana.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pause notifications

Enable changing "pause notifications" state manually

com.unblu.pausenotifications.enableManualPauseNotificationsMode

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Allows agents to change their "pause notifications" state manually

Initial "pause notifications" mode

com.unblu.pausenotifications.initialPauseNotificationsMode

  • Type: String with allowed values:

    • auto

    • off

  • Default: OFF

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The "pause notifications" mode initially assigned to all new agents

StorageManagement

internalTeamManagementEnabled

com.unblu.storage.management.internalTeamManagementEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether internally managed teams can be created, edited, and/or deleted.

internalUserManagementEnabled

com.unblu.storage.management.internalUserManagementEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether internally managed users can be created, edited, and/or deleted.

limitedImpersonatedSuperAdminUserManagementEnabled

com.unblu.storage.management.limitedImpersonatedSuperAdminUserManagementEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Specifies whether superadmins are allowed to create any type of user when impersonating an account or if they are limited to creating only technical admin users.

VisitorSessionCookieConfiguration

Time to live, in seconds, for the visitor session cookie

com.unblu.visitorsession.cookieExpirationTime

  • Type: Integer

  • Default: 300

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Set to 0 to make it a session cookie

Name of the visitor session cookie

com.unblu.visitorsession.cookieName

  • Type: String

  • Default: ${cookieNamePrefix}-visitor-session

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set when the visitor’s session gets connected. The cookie can have an expiration time or act as a session cookie. It is used to fully initialize Unblu after a page navigation.

RoleFeaturePermissionsConfiguration

User roles allowed to delete a conversation

com.unblu.permission.roleAllowed.deleteConversations

  • Type: List of string with allowed values:s

    • admin

    • super_admin

  • Default: SUPER_ADMIN, ADMIN

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The configuration property applies to changes made in the UI and through the web API

User roles allowed to apply changes to the configuration

com.unblu.permission.roleAllowed.modifyConfigurations

  • Type: List of string with allowed values:s

    • admin

    • registered_user

    • supervisor

    • super_admin

    • technical_admin

  • Default: SUPER_ADMIN, TECHNICAL_ADMIN, ADMIN, SUPERVISOR, REGISTERED_USER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The configuration property applies to changes made in the UI and through the web API

User roles allowed to apply changes to metadata

com.unblu.permission.roleAllowed.modifyMetadata

  • Type: List of string with allowed values:s

    • admin

    • registered_user

    • supervisor

    • technical_admin

  • Default: TECHNICAL_ADMIN, ADMIN, SUPERVISOR

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The configuration property applies to changes made in the UI and through the web API

User roles allowed to apply changes to texts

com.unblu.permission.roleAllowed.modifyTexts

  • Type: List of string with allowed values:s

    • admin

    • technical_admin

  • Default: TECHNICAL_ADMIN, ADMIN

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The configuration property applies to changes made in the UI and through the web API

User roles allowed to open conversations as GHOST

com.unblu.permission.roleAllowed.openConversationAsGhost

  • Type: List of string with allowed values:s

    • admin

    • registered_user

    • supervisor

    • super_admin

  • Default: SUPER_ADMIN, ADMIN, SUPERVISOR, REGISTERED_USER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If disabled for a role, opening the conversation from the conversation history automatically opens it in "normal" mode. If the user isn’t a participant of the conversation, an error dialog is displayed. Conversations in "QUEUED" state are excluded from this setting because GHOST must be able to join conversations for the "preview" feature.

User roles allowed to override team management settings

com.unblu.permission.roleAllowed.overrideTeamManagement

  • Type: List of string with allowed values:s

    • admin

    • supervisor

    • super_admin

    • technical_admin

  • Default: SUPER_ADMIN, TECHNICAL_ADMIN, ADMIN, SUPERVISOR

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

This includes changing whether teams are internally or externally managed, creating new teams even if internal team management isn’t enabled and deleting externally managed teams

User roles allowed to override user management settings

com.unblu.permission.roleAllowed.overrideUserManagement

  • Type: List of string with allowed values:s

    • admin

    • registered_user

    • supervisor

    • super_admin

    • technical_admin

  • Default: SUPER_ADMIN, TECHNICAL_ADMIN, ADMIN, SUPERVISOR, REGISTERED_USER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

This includes changing whether users are internally or externally managed, creating new users even if internal user management isn’t enabled and deleting externally managed users

WebRTC configuration

credentialSecretKey

com.unblu.webrtc.credentialSecretKey

  • Type: Secret

  • Default: MWU5Mjk4MWMtZmRlOS0xMWU4LThlYjItZjI4MDFmMWI5ZmQx

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The authentication secret used for the TURN server to encode/decode the authentication token. Must match with the auth secret configured on the TURN server.

Credential TTL TURN server

com.unblu.webrtc.credentialTTL

  • Type: Integer

  • Default: 60

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The TTL for the credential to get redeemed against the TURN server.

iceServer

com.unblu.webrtc.iceServer

  • Type: String

  • Default: stun.l.google.com

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

A STUN/TURN server used to resolve the local ip of the peer (e.g stun.l.google.com).

iceServers

com.unblu.webrtc.iceServers

  • Type: List of strings

  • Default: ["stun:${iceServer}:19302"]

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

A list of STUN/TURN servers and protocols used to resolve the local ip of the peer (e.g stun:stun.l.google.com:19302). Use ${iceServer} as placeholder for the value of com.unblu.webrtc.iceServer

udpPortRangeEnd

com.unblu.webrtc.udpPortRangeEnd

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The end of the range of UDP ports to allocate ports from for the webRTC P2P connection. The default value is null, for automatic port allocation.

udpPortRangeStart

com.unblu.webrtc.udpPortRangeStart

  • Type: Integer

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The start of the range of UDP ports to allocate ports from for the webRTC P2P connection. The default value is null, for automatic allocation.

useRelayOnly

com.unblu.webrtc.useRelayOnly

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether to force TURN relay only or not.

File manager configuration

Blocked content HTTP response status code

com.unblu.filemanager.blockedContentHttpResponseStatusCode

  • Type: Integer

  • Default: 415

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

HTTP status code that marks uploads that were rejected for security reasons. We recommend using 409, 415 or 403, or a custom non-standard 4xx status code. The default is to expect 415.

Enable file download

com.unblu.filemanager.fileDownloadsEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable downloading files in the file manager

Evaluation order of file type allow/deny lists

com.unblu.filemanager.fileTypeBlackWhiteOrder

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: WHITE_BLACK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The order in which to evaluate the deny list and allow list for file types. There are two possible values, BLACK_WHITE and WHITE_BLACK. BLACK_WHITE: First, the deny list is searched for the file type. If it is not found, the file is considered valid. If the file type is found in the deny list, the allow list is also searched for the file type. If the file type is not found in the allow list, the file is rejected. WHITE_BLACK: First, the allow list is searched for the file type. If it is not found, the file is rejected. If the file type is found, the deny list is searched for the file type. If the file type is not found in the deny list, the file is considered valid.

If you use only a deny list or an allow list, the effect will be he same irrespective of this configuration property.

File upload type blacklist

com.unblu.filemanager.fileTypeBlacklist

  • Type: List of string with allowed values:s

    • any

    • exec_android_apk

    • exec_dalvik

    • exec_dalvik_fe

    • exec_elf

    • exec_ios_ipa

    • exec_linux_ksh

    • exec_linux_out

    • exec_linux_run

    • exec_macos_app

    • exec_macos_automator

    • exec_macos_command

    • exec_macos_osx

    • exec_macos_workflow

    • exec_msdos_bat

    • exec_msdos_com

    • exec_msdos_mz_exe

    • exec_mswindows_cmd

    • exec_mswindows_cpl

    • exec_mswindows_exe

    • exec_mswindows_gadget

    • exec_mswindows_inf

    • exec_mswindows_installer

    • exec_mswindows_installer_patch

    • exec_mswindows_inx

    • exec_mswindows_isu

    • exec_mswindows_job

    • exec_mswindows_jscript

    • exec_mswindows_link

    • exec_mswindows_msc

    • exec_mswindows_mst

    • exec_mswindows_paf

    • exec_mswindows_pif

    • exec_mswindows_powershell

    • exec_mswindows_prg

    • exec_mswindows_registry

    • exec_mswindows_rgs

    • exec_mswindows_screensaver

    • exec_mswindows_scriptlet

    • exec_mswindows_shb

    • exec_mswindows_shs

    • exec_mswindows_u3p

    • exec_mswindows_vbe

    • exec_mswindows_vbs

    • exec_mswindows_vbscript

    • exec_mswindows_visualbasicscript

    • exec_mswindows_ws

    • exec_mswindows_wsf

    • exec_mswindows_wsh

    • exec_multi_bin

    • exec_multi_csh

    • group_any

    • group_exec

    • group_image

    • group_office

    • group_pdf

    • image_gif_87a

    • image_gif_89a

    • image_jpeg

    • image_jpeg_alt

    • image_jpeg_exif

    • image_jpeg_jfif

    • image_jpg

    • image_jpg_alt

    • image_jpg_exif

    • image_jpg_jfif

    • image_png

    • office_microsoft_excel

    • office_microsoft_excel_empty

    • office_microsoft_excel_spanned

    • office_microsoft_legacy

    • office_microsoft_legacy_excel

    • office_microsoft_legacy_outlook

    • office_microsoft_legacy_powerpoint

    • office_microsoft_legacy_word

    • office_microsoft_powerpoint

    • office_microsoft_powerpoint_empty

    • office_microsoft_powerpoint_spanned

    • office_microsoft_visio

    • office_microsoft_visio_empty

    • office_microsoft_visio_spanned

    • office_microsoft_word

    • office_microsoft_word_empty

    • office_microsoft_word_spanned

    • office_openoffice_calc

    • office_openoffice_calc_empty

    • office_openoffice_calc_spanned

    • office_openoffice_presentation

    • office_openoffice_presentation_empty

    • office_openoffice_presentation_spanned

    • office_openoffice_writer

    • office_openoffice_writer_empty

    • office_openoffice_writer_spanned

    • office_pdf

  • Default: GROUP_EXEC

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Set of file types on the blacklist. Used to check a file type before uploading it.

fileTypeInputTagHint

com.unblu.filemanager.fileTypeInputTagHint

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Set the "accept" attribute on file input tags. Note that this is only a hint, because it is not taken into consideration by all browsers and users can override the values. Check https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes/accept for possible values.

File upload type whitelist

com.unblu.filemanager.fileTypeWhitelist

  • Type: List of string with allowed values:s

    • any

    • exec_android_apk

    • exec_dalvik

    • exec_dalvik_fe

    • exec_elf

    • exec_ios_ipa

    • exec_linux_ksh

    • exec_linux_out

    • exec_linux_run

    • exec_macos_app

    • exec_macos_automator

    • exec_macos_command

    • exec_macos_osx

    • exec_macos_workflow

    • exec_msdos_bat

    • exec_msdos_com

    • exec_msdos_mz_exe

    • exec_mswindows_cmd

    • exec_mswindows_cpl

    • exec_mswindows_exe

    • exec_mswindows_gadget

    • exec_mswindows_inf

    • exec_mswindows_installer

    • exec_mswindows_installer_patch

    • exec_mswindows_inx

    • exec_mswindows_isu

    • exec_mswindows_job

    • exec_mswindows_jscript

    • exec_mswindows_link

    • exec_mswindows_msc

    • exec_mswindows_mst

    • exec_mswindows_paf

    • exec_mswindows_pif

    • exec_mswindows_powershell

    • exec_mswindows_prg

    • exec_mswindows_registry

    • exec_mswindows_rgs

    • exec_mswindows_screensaver

    • exec_mswindows_scriptlet

    • exec_mswindows_shb

    • exec_mswindows_shs

    • exec_mswindows_u3p

    • exec_mswindows_vbe

    • exec_mswindows_vbs

    • exec_mswindows_vbscript

    • exec_mswindows_visualbasicscript

    • exec_mswindows_ws

    • exec_mswindows_wsf

    • exec_mswindows_wsh

    • exec_multi_bin

    • exec_multi_csh

    • group_any

    • group_exec

    • group_image

    • group_office

    • group_pdf

    • image_gif_87a

    • image_gif_89a

    • image_jpeg

    • image_jpeg_alt

    • image_jpeg_exif

    • image_jpeg_jfif

    • image_jpg

    • image_jpg_alt

    • image_jpg_exif

    • image_jpg_jfif

    • image_png

    • office_microsoft_excel

    • office_microsoft_excel_empty

    • office_microsoft_excel_spanned

    • office_microsoft_legacy

    • office_microsoft_legacy_excel

    • office_microsoft_legacy_outlook

    • office_microsoft_legacy_powerpoint

    • office_microsoft_legacy_word

    • office_microsoft_powerpoint

    • office_microsoft_powerpoint_empty

    • office_microsoft_powerpoint_spanned

    • office_microsoft_visio

    • office_microsoft_visio_empty

    • office_microsoft_visio_spanned

    • office_microsoft_word

    • office_microsoft_word_empty

    • office_microsoft_word_spanned

    • office_openoffice_calc

    • office_openoffice_calc_empty

    • office_openoffice_calc_spanned

    • office_openoffice_presentation

    • office_openoffice_presentation_empty

    • office_openoffice_presentation_spanned

    • office_openoffice_writer

    • office_openoffice_writer_empty

    • office_openoffice_writer_spanned

    • office_pdf

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Set of file types on the whitelist. Used to check a file type before uploading it.

Maximum file upload size

com.unblu.filemanager.maximumUploadSize

  • Type: Integer

  • Default: 15728640

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum file upload size in bytes

Agent availability

Agent availability override

com.unblu.agentavailability.availabilityOverride

  • Type: String with allowed values:

    • always_available

    • calculated

    • never_available

  • Default: CALCULATED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Override the agent availability calculation. Possible values are ALWAYS_AVAILABLE, NEVER_AVAILABLE, and CALCULATED: ALWAYS_AVAILABLE overrides the dynamic calculation of agent availability, and the system always states that an agent is available. NEVER_AVAILABLE also overrides dynamic calculation of agent availability, but the systems always states that no agent is available. CALCULATED dynamically calculates whether there is an agent available or not.

This configuration property doesn’t affect agents' personal availability status as displayed in the agent availability panel of the agent monitor.

Changes to this property are only valid in the GLOBAL, ACCOUNT, and NAMED_AREA scopes.

Busy state session limit for priority 1 conversations

com.unblu.agentavailability.busyStateSessionLimit

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

The number of ongoing priority 1 conversations at which an agent’s status switches to BUSY. If set to -1, there is no limit.

Busy state session limit for priority 2 conversations

com.unblu.agentavailability.busyStateSessionLimitPriority2

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The number of ongoing priority 2 conversations at which an agent’s status switches to BUSY for priority 2, priority 3, and priority 4 conversations. They remain available for priority 1 conversations.

Busy state session limit for priority 3 conversation limits

com.unblu.agentavailability.busyStateSessionLimitPriority3

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The number of ongoing priority 3 conversations at which an agent’s status switches to BUSY for priority 3 and priority 4 conversations. They remain available for priority 1 and priority 2 conversations.

Busy state session limit for priority 4 conversations

com.unblu.agentavailability.busyStateSessionLimitPriority4

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The number of ongoing priority 4 conversations at which an agent’s status switches to BUSY for priority 4 conversations. They remain available for priority 1, priority 2, and priority 3 conversations.

Agent availability re-fetch timeout (in ms)

com.unblu.agentavailability.clientSideCacheTimeoutMS

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout in milliseconds until agent availability is fetched from the server again

Maximum active sessions per agent

com.unblu.agentavailability.maxActiveSessionLimit

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Limit on the number of active sessions an agent can have. If set to -1, there is no limit. The limit doesn’t affect the agent’s state.

Mapping of queue sort order to priority

com.unblu.agentavailability.queueSortingOrderToPriorityMapping

  • Type: List of integers

  • Default: []

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A list used to group conversations by their queue sorting order and assign them a priority that is then used to calculate an agent’s availability. Each element corresponds to the minimum queue sorting order value that maps to the busyStateSessionLimitPriority indicated by the value’s index in the list. The first element specifies the minimum queue sorting order for counting a conversation towards busyStateSessionLimit (priority 1), the second to busyStateSessionLimitPriority2, and so on. The entries must be in ascending order, from the smallest to the largest value.\n If the list is empty, all conversations will be counted as having priority 1. If the list contains fewer than four entries, the lower priorities aren’t used. If the list contains more than 4 entries, only the first four entries are considered.

Treat "busy" state as "available"

com.unblu.agentavailability.treatBusyAsAvailable

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines if the Unblu state should be available or offline when all agents are busy

UI Notifications

Notification destination

com.unblu.core.client.ui.notification.NotificationService.notificationDestination

  • Type: String with allowed values:

    • both

    • desktop

    • toast

  • Default: BOTH

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Define where notifications should be displayed. Possible values are DESKTOP, TOAST, and BOTH.

PersonTrackingConfiguration

Polling interval for "LOW" delay preset in milliseconds

com.unblu.personTracking.lowDelayPollingInterval

  • Type: Integer

  • Default: 3000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Factor for calculating "MEDIUM" polling interval

com.unblu.personTracking.lowToMediumPollingIntervalFactor

  • Type: Float

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The factor used to calculate the medium latency polling interval based on the "LOW' delay preset. For example, with the default values for this property and lowDelayPollingInterval, the "MEDIUM" delay polling interval is 2 * 3000 ms = 6000 ms, or 6 seconds.

Maximum duration of site navigation

com.unblu.personTracking.maxExpectedSiteNavigationDuration

  • Type: Integer

  • Default: 30000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum expected time span for a person to be absent from a session because they’re navigating from one Unblu-enabled page to another. The duration includes the time it takes to load Unblu fully on the new page.

Maximum delay if visitor session activation is required

com.unblu.personTracking.maxPersonActivationDelay

  • Type: String with allowed values:

    • high

    • low

    • medium

  • Default: LOW

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Maximum delay before Unblu gets fully initialized on the frontend for a user if activation is required. "LOW" is the shortest delay, "HIGH" is the longest. The delay affects how quickly the Unblu frontend can react to events in the Unblu backend, for example an incoming message or call, because it influences how often the frontend polls the backend for changes. In integrations with inbound calls, use "LOW".

Factor for calculating "HIGH" polling interval

com.unblu.personTracking.mediumToHighPollingIntervalFactor

  • Type: Float

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The factor used to calculate the high latency polling interval based on the "MEDIUM" delay preset. FOr example, with the default values for this property and the "MEDIUM" delay preset, the "HIGH" delay polling interval is 2 * 6000 ms = 12000 ms, or 12 seconds. Note that the "MEDIUM" delay preset is itself calculated form a factor and the "LOW" delay preset.

Push notifications

"Inbound request" notification actions

com.unblu.core.push_notification.agentTargetedInboundRequestAvailableNotificationActions

  • Type: List of string with allowed values:s

    • accept

    • decline

    • ignore

    • later

  • Default: ACCEPT,LATER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A maximum of two actions may be selected. "Accept" accepts the request. "Ignore" ignores the request and does nothing. "Later" accepts the request internally and sends the predefined message to the conversation about dealing with the request later. "Decline" cancels the request for everyone.

"Deputy delegation" notification actions

com.unblu.core.push_notification.deputyDelegationAvailableNotificationActions

  • Type: List of string with allowed values:s

    • accept

    • decline

    • ignore

    • later

  • Default: ACCEPT,LATER

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

A maximum of two actions may be selected. "Accept" accepts the request. "Ignore" ignores the request and does nothing. "Later" accepts the request internally and sends the predefined message to the conversation about dealing with the request later. "Decline" cancels the request for everyone.

Enable declining invitations and forwardings from an agent

com.unblu.core.push_notification.enableDeclineAgentInvitationsAndForwardings

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable push notifications

com.unblu.core.push_notification.enablePushNotification

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Push notification debounce delay (in ms)

com.unblu.core.push_notification.pushNotificationDebounceDelay

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Integer

  • Default: 1000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The interval, in milliseconds, before a notification is sent, allowing the new message to be marked as read. Within a conversation, only one notification is sent for all messages sent within the time interval. Each new message delays the sending of the notification by the interval specified.

Push notification debounce delay while active in conversation (in ms)

com.unblu.core.push_notification.pushNotificationDebounceDelayWhenInConversation

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The interval, in milliseconds, before a push notification is sent. The push notification allows the user to mark new messages as read, provided the person has an active connection to the conversation but isn’t currently viewing it. For each conversation, only one notification is sent for all messages received within the interval. Each new message resets the countdown of the interval, so push notifications for a message may be delayed for longer than the interval specified.

Web push notifications

Enable web push notifications

com.unblu.core.web_push_notification.enableWebPushNotification

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Proxy URL for web push notifications

com.unblu.core.web_push_notification.proxyUrl

Only visible if: com.unblu.core.web_push_notification.enableWebPushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Proxy server URL to be used by the Unblu server to access the web push notification server. Supported format: http:[<username>:<password>@]<host>:<port> (no other protocols). Currently, only basic authentication is supported.

Push notification action expiry timeout (in min)

com.unblu.core.web_push_notification.pushNotificationActionExpiryTimeout

  • Type: Integer

  • Default: 2880

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Timeout, in minutes, for push notification actions before they can no longer be used

VAPID email address

com.unblu.core.web_push_notification.vapidEmailAddress

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Email address added to the push notification’s JSON Web Token (JWT) in accordance with the Voluntary Application Server Identification (VAPID) protocol

VAPID private key

com.unblu.core.web_push_notification.vapidPrivateKey

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

ECDSA private key used for push notifications following the Voluntary Application Server Identification (VAPID) protocol

VAPID public key

com.unblu.core.web_push_notification.vapidPublicKey

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

ECDSA public key that will be shared with the push notification service according to the Voluntary Application Server Identification (VAPID) protocol

Record retention

Time from which hint about audit log deletion is displayed

com.unblu.record_retention.auditLogDeletionHintDisplayThreshold

  • Type: String with allowed values:

    • day_before_deletion

    • day_of_deletion

    • do_not_show_hint

    • one_week_before_deletion

  • Default: ONE_WEEK_BEFORE_DELETION

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The hint appears as an icon with a tooltip in the audit log in the Account Configuration interface

Default retention interval for audit changes (in s)

com.unblu.record_retention.auditLogRetentionIntervalDefault

  • Type: Integer

  • Default: 31536000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

The default value is 365 days, the minimum value is 1 day. Note: Changing the configuration property doesn´t have an effect on the retention interval for audit logs once an account’s been created.

Maximum retention interval for audit changes (in s)

com.unblu.record_retention.auditLogRetentionIntervalMaximum

  • Type: Integer

  • Default: 63072000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

Used as an upper boundary when setting the retention interval for audit logs. The default value is 730 days, the minimum value is 1 day.

Time from which hint about conversation deletion is displayed

com.unblu.record_retention.conversationDeletionHintDisplayThreshold

  • Type: String with allowed values:

    • day_before_deletion

    • day_of_deletion

    • do_not_show_hint

    • one_week_before_deletion

  • Default: ONE_WEEK_BEFORE_DELETION

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The hint appears as an icon with a tooltip in the conversation history in the Agent Desk

Default retention interval for conversations (in s)

com.unblu.record_retention.conversationRetentionIntervalDefault

  • Type: Integer

  • Default: 15552000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

The default value is 180 days, the minimum value is 1 day. Note: Changing the configuration property doesn´t have an effect on the retention interval for conversations once an account’s been created.

Maximum retention interval for conversations (in s)

com.unblu.record_retention.conversationRetentionIntervalMaximum

  • Type: Integer

  • Default: 63072000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

Used as an upper boundary when setting the retention interval for conversations. The default value is 730 days, the minimum value is 1 day.

Time from which hint about person presence deletion is displayed

com.unblu.record_retention.personPresenceDeletionHintDisplayThreshold

  • Type: String with allowed values:

    • day_before_deletion

    • day_of_deletion

    • do_not_show_hint

    • one_week_before_deletion

  • Default: ONE_WEEK_BEFORE_DELETION

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Default retention interval for person presence information (in s)

com.unblu.record_retention.presenceRetentionIntervalDefault

  • Type: Integer

  • Default: 2592000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

The default value is 30 days, the minimum value is 1 day. Note: Changing the configuration property doesn´t have an effect on the retention interval for person presences once an account’s been created.

Maximum retention interval for (person) presence information (in s)

com.unblu.record_retention.presenceRetentionIntervalMaximum

  • Type: Integer

  • Default: 63072000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 86400

Used as an upper boundary when setting the retention interval for person presences. The default value is 730 days, the minimum value is 1 day.

Default retention interval for webhook call logs (in s)

com.unblu.record_retention.webhookCallLogRetentionIntervalDefault

  • Type: Integer

  • Default: 604800

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 3600

The default value is 7 days, the minimum value is 1 hour. Note: Changing the configuration property doesn´t have an effect on the retention interval for webhook call logs once an account’s been created.

Maximum retention interval for webhook call logs (in s)

com.unblu.record_retention.webhookCallLogRetentionIntervalMaximum

  • Type: Integer

  • Default: 5184000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 3600

Used as an upper boundary when setting the retention interval for webhook call logs. The default value is 60 days, the minimum value is 1 hour.

Time from which hint about webhook call log deletion is displayed

com.unblu.record_retention.webhookDeliveryLogDeletionHintDisplayThreshold

  • Type: String with allowed values:

    • day_before_deletion

    • day_of_deletion

    • do_not_show_hint

    • one_week_before_deletion

  • Default: ONE_WEEK_BEFORE_DELETION

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The hint appears as an icon with a tooltip in the respective webhook’s delivery log in the Account Configuration interface

User storage configuration

Enable admin define password

com.unblu.storage.user.canAdminDefinePasswordForUserEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determine whether an admin can set a user’s password

Allow creating random password

com.unblu.storage.user.canCreateRandomPasswordOnCreationAndEditEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether a random password can be created when user is created or edited

Allow user to set password

com.unblu.storage.user.canUserDefineCustomPassword

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether users can change their own password

Allow creating users without a password

com.unblu.storage.user.isCreationOfUsersWithEmptyPasswordAllowed

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether users can be created without a password. This option is required for single sign-on (SSO) implementations.

Use email as username

com.unblu.storage.user.useEmailAsUsername

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to use the email address as the username, or whether the username and email may be different

Conversation recipient display name evaluator

Account display name

com.unblu.conversationrecipient.displayname.accountDisplayName

  • Type: String with allowed values:

    • name

    • static_name

  • Default: NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value used for the display name if the recipient of a conversation is the account. The value is one of NAME or STATIC_NAME.

Agent display name

com.unblu.conversationrecipient.displayname.agentDisplayName

  • Type: String with allowed values:

    • name

    • static_name

  • Default: NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value used for the display name if the recipient of a conversation is an agent Person. The value is one of NAME or STATIC_NAME.

Named area display name

com.unblu.conversationrecipient.displayname.namedAreaDisplayName

  • Type: String with allowed values:

    • name

    • static_name

  • Default: NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value used for the display name if the recipient of a conversation is a named area. The value is one of NAME or STATIC_NAME.

Team display name

com.unblu.conversationrecipient.displayname.teamDisplayName

  • Type: String with allowed values:

    • name

    • static_name

  • Default: NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value used for the display name if the recipient of a conversation is a team. The value is one of NAME or STATIC_NAME.

Localized entity display name configuration

Account display name format

com.unblu.localizedentity.displayname.accountDisplayNameFormat

  • Type: String with allowed values:

    • localized_name

    • technical_name

  • Default: LOCALIZED_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines the display name for the account. The possible values are TECHNICAL_NAME or LOCALIZED_NAME.

Conversation template display name format

com.unblu.localizedentity.displayname.conversationTemplateDisplayNameFormat

  • Type: String with allowed values:

    • localized_description

    • localized_name

    • technical_description

    • technical_name

  • Default: LOCALIZED_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines the display name for conversation templates. The possible values are TECHNICAL_NAME, TECHNICAL_DESCRIPTION, LOCALIZED_NAME, or LOCALIZED_DESCRIPTION.

Custom action display name format

com.unblu.localizedentity.displayname.customActionDisplayNameFormat

  • Type: String with allowed values:

    • localized_description

    • localized_name

    • technical_description

    • technical_name

  • Default: LOCALIZED_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines the display name for custom actions. The possible values are TECHNICAL_NAME, TECHNICAL_DESCRIPTION, LOCALIZED_NAME, or LOCALIZED_DESCRIPTION.

Named area display name format

com.unblu.localizedentity.displayname.namedAreaDisplayNameFormat

  • Type: String with allowed values:

    • localized_description

    • localized_name

    • technical_description

    • technical_name

  • Default: LOCALIZED_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines the display name for named areas. The possible values are TECHNICAL_NAME, TECHNICAL_DESCRIPTION, LOCALIZED_NAME, or LOCALIZED_DESCRIPTION.

Team display name format

com.unblu.localizedentity.displayname.teamDisplayNameFormat

  • Type: String with allowed values:

    • localized_description

    • localized_name

    • technical_description

    • technical_name

  • Default: LOCALIZED_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Determines the display name for teams. The possible values are TECHNICAL_NAME, TECHNICAL_DESCRIPTION, LOCALIZED_NAME, or LOCALIZED_DESCRIPTION.

Person display name

Agent display name evaluation order

com.unblu.person.displayname.agentDisplayNameEvaluationOrder

  • Type: List of string with allowed values:s

    • first

    • first_last

    • identifier

    • last

    • last_first

    • nickname

    • qualified_static_name

    • static_name

    • username

  • Default: FIRST_LAST,USERNAME,IDENTIFIER,STATIC_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value is a list consisting of one or more of FIRST, FIRST_LAST, IDENTIFIER, LAST, LAST_FIRST, NICKNAME, QUALIFIED_STATIC_NAME, STATIC_NAME, and USERNAME. The first element of the list whose evaluation returns a value will be used as the agent’s display name.

Bot display name evaluation order

com.unblu.person.displayname.botDisplayNameEvaluationOrder

  • Type: List of string with allowed values:s

    • first

    • first_last

    • identifier

    • last

    • last_first

    • nickname

    • qualified_static_name

    • static_name

    • username

  • Default: FIRST_LAST,STATIC_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value is a list consisting of one or more of FIRST, FIRST_LAST, IDENTIFIER, LAST, LAST_FIRST, NICKNAME, QUALIFIED_STATIC_NAME, STATIC_NAME, and USERNAME. The first element of the list whose evaluation returns a value will be used as the bot’s display name.

Qualified static name qualifier length

com.unblu.person.displayname.qualifiedStaticNameQualifierLength

  • Type: Integer

  • Default: 5

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

    • Maximum value: 22

Length of the qualifier (first characters of the person ID) displayed in the qualified static name. Must be between 1 and 22

Visitor display name evaluation order

com.unblu.person.displayname.visitorDisplayNameEvaluationOrder

  • Type: List of string with allowed values:s

    • first

    • first_last

    • identifier

    • last

    • last_first

    • nickname

    • qualified_static_name

    • static_name

    • username

  • Default: FIRST_LAST,USERNAME,NICKNAME,IDENTIFIER,QUALIFIED_STATIC_NAME

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value is a list consisting of one or more of FIRST, FIRST_LAST, IDENTIFIER, LAST, LAST_FIRST, NICKNAME, QUALIFIED_STATIC_NAME, STATIC_NAME, and USERNAME. The first element of the list whose evaluation returns a value will be used as the visitor’s display name.

Embedded co-browsing recorder configuration

Enable periodic full capturing

com.unblu.recorder.capturePeriodicallyEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable periodic full capturing. Usually this is not required because everything is captured based on event synchronization.

Enable diagnostics UI

com.unblu.recorder.diagnosticInterfaceEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Display a diagnostic UI for debugging purposes

Maximum DOM nodes captured

com.unblu.recorder.maxNodes

  • Type: Integer

  • Default: 45000

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of DOM nodes the recorder should process. If more nodes are found, the recorder will refuse to capture the page.

Maximum nodes threshold per modification

com.unblu.recorder.maxNodesPerModificationThreshold

  • Type: Integer

  • Default: 256

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of mutations (from the mutation observer) to handle before falling back to a full capture instead

Embedded co-browsing experimental event support

Enable "change" event on change

com.unblu.react.recorder.experimental.enableChangeOnChange

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Fire a DOM "change" event when a "change" event request arrives on an input field

Enable "mousedown" event on click

com.unblu.react.recorder.experimental.enableMouseDownOnClick

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Play a "mousedown" event in addition to a "click" when an element is clicked. This feature is experimental.

Enable "mouseup" event on click

com.unblu.react.recorder.experimental.enableMouseUpOnClick

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Play a "mouseup" event in addition to a "click" when an element is clicked. This feature is experimental.

Embedded co-browsing missing resource loader configuration

Number of parallel fetch requests

com.unblu.domcap.client.recorder.internal.MissingResourceURILoader.maxConcurrentRequests

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum number of concurrent fetch requests

Show diagnostics UI

com.unblu.domcap.client.recorder.internal.MissingResourceURILoader.showDiagUi

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Show the diagnostics UI

Shuffle URL loading

com.unblu.domcap.client.recorder.internal.MissingResourceURILoader.shuffle

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Embedded co-browsing DOM processing configuration

enableDynamicStylesheetSupport

com.unblu.domcap.enableDynamicStylesheetSupport

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether to enable the dynamic stylesheet capturing support

Skip element function name

com.unblu.domcap.externalSkipElementFunctionName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of a global JavaScript function that should be called to check if an element should be skipped. A single parameter holding the current node will be passed to that function. The function is expected to return a boolean value. CAUTION: The function must already exist when the recorder starts, otherwise it will be ignored.

Propagate text masking

com.unblu.domcap.maskTextInheritFromParent

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Inherit text masking from the parent node

Cache detection of masked texts

com.unblu.domcap.maskTextPersist

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Cache the detection of masked texts during DOM capturing

Use sequential IDs

com.unblu.domcap.sequentialIdEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Use sequential IDs. If not enabled, random IDs are used.

DOM capturing: replace "carriage return" with "new line"

com.unblu.domcap.unblu3487ReplaceCarriageReturnWithNewlineInPre

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Replace "carriage return" with "new line" during DOM capturing of preformatted (PRE) elements

Embedded co-browsing DOM configuration

DOM capture recorder idle timeout (in s)

com.unblu.domcap.idleTimeoutSeconds

  • Type: Integer

  • Default: 40

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Idle timeout, in seconds, for the DOM capture recorder

IcapBundleActivator

enableAirlockIcap

com.unblu.domcap.server.filter.airlock.enableAirlockIcap

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not airlock icap functionality is enabled

IcapHttpServletRequest

hostScheme

com.unblu.domcap.server.filter.airlock.request.hostScheme

  • Type: String

  • Default: https

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Scheme used by the backend (i.e. e-banking application) to construct the request URI. This is needed because the ICAP interface does not provide this information.

backendPattern

com.unblu.domcap.server.filter.airlock.url.backendPattern

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The backend host pattern (i.e regex) of the application (including scheme) how it’s mapped by airlock. In certain circumstances (request host header rewrite by airlock) the ICAP API delivers only the backend host as the request host. To make the resourcehistory feature work properly this property needs to be configured as well as the frontend pattern property.

frontendPattern

com.unblu.domcap.server.filter.airlock.url.frontendPattern

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The frontend host pattern (i.e. regex) of the application (including scheme) as it’s seen by the client. In certain circumstances (request host header rewrite by airlock) it’s necessary to configure this property to make the resourcehistory feature work properly.

Embedded co-browsing default filter configuration

black

com.unblu.server.filter.download.black

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list that identifies resources as downloads (which will be shown in the download manager)

order

com.unblu.server.filter.download.order

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: WHITE_BLACK

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list that identifies resources as downloads (which will be shown in the download manager)

white

com.unblu.server.filter.download.white

  • Type: List of strings

  • Default: application/pdf,application/x-pdf,text/csv,text/x-comma-separated-values

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Pattern black/white list that identifies resources as downloads (which will be shown in the download manager)

External filter configuration

com.unblu.server.filter.externalFilterConfiguration

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Path to an external filter configuration file that should be used instead of the default embedded co-browsing filter

Filter support for last meta position

com.unblu.server.filter.filterSupportsLastMetaPosition

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether the filter in use supports the injection location AFTER_META_CONTENT_TYPE, which was introduced with 3.4.2

Enable offline injection

com.unblu.server.filter.offlineInjectionEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to enable offline injection

RecorderSessionCookieConfiguration

Name of the recorder session cookie

com.unblu.domcap.cookieName

  • Type: String

  • Default: ${cookieNamePrefix}-recorder-session

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the worker origin cookie

com.unblu.domcap.originCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-worker-origin

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

GrafanaAnalyticsConfiguration

Selection of enabled dashboards

com.unblu.analytics.grafana.dashboards

Only visible if: com.unblu.analytics.grafana.enabled=true

  • Type: List of string with allowed values:s

    • details

    • general

  • Default: ["GENERAL","DETAILS"]

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MobileKeyboardButtonConfiguration

Hover background color

com.unblu.hbworker.ui.mobileKeyboardButton.backgroundHover

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "headless browser mobile keyboard" button in "hovered" state

Normal background color

com.unblu.hbworker.ui.mobileKeyboardButton.backgroundNormal

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -20%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "headless browser mobile keyboard" button in "normal" state

Press background color

com.unblu.hbworker.ui.mobileKeyboardButton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "headless browser mobile keyboard" button in "pressed" state

Hover border color

com.unblu.hbworker.ui.mobileKeyboardButton.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "headless browser mobile keyboard" button in "hovered" state

Normal border color

com.unblu.hbworker.ui.mobileKeyboardButton.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "headless browser mobile keyboard" button in "normal" state

Press border color

com.unblu.hbworker.ui.mobileKeyboardButton.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "headless browser mobile keyboard" button in "pressed" state

Border radius

com.unblu.hbworker.ui.mobileKeyboardButton.borderRadius

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the "headless browser mobile keyboard" button

Border width

com.unblu.hbworker.ui.mobileKeyboardButton.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "headless browser mobile keyboard" button

Hover foreground color

com.unblu.hbworker.ui.mobileKeyboardButton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "headless browser mobile keyboard" button in "hovered" state

Normal foreground color

com.unblu.hbworker.ui.mobileKeyboardButton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "headless browser mobile keyboard" button in "normal" state

Press foreground color

com.unblu.hbworker.ui.mobileKeyboardButton.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "headless browser mobile keyboard" button in "pressed" state

DockerClientConfiguration

auth

com.unblu.docker.client.auth

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Base64 encoded authentication string to authenticate against docker registry.

identityToken

com.unblu.docker.client.auth.identityToken

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

identity token to authenticate against docker registry.

password

com.unblu.docker.client.auth.password

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

password to authenticate against docker registry.

username

com.unblu.docker.client.auth.username

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

username to authenticate against docker registry.

cpuPeriod

com.unblu.docker.client.container.cpuPeriod

  • Type: Integer

  • Default: -1

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Specifies the CPU CFS scheduler, which is used alongside 'cpuQuota'. Defaults to 100 milliseconds. Units are in microseconds.

cpuQuota

com.unblu.docker.client.container.cpuQuota

  • Type: Integer

  • Default: -1

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Imposes a CPU CFS quota on the container. The number of microseconds per 'cpuPeriod' that the container is limited to before throttled.

enableConstraints

com.unblu.docker.client.container.enableConstraints

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether to apply constraints, like maximum memory usage, amount of used CPUs, /dev/shm size, or not.

memory

com.unblu.docker.client.container.memory

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

maximum amount of memory the container can use. If set, the minimum allowed value is 4m (4 megabyte).

oomKillDisable

com.unblu.docker.client.container.oomKillDisable

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Defines whether to disable OOM Killer for the container or not.

oomScoreAdj

com.unblu.docker.client.container.oomScoreAdj

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1000

    • Maximum value: 1000

Tunes container’s OOM preferences (-1000 to 1000).

shmSize

com.unblu.docker.client.container.shmSize

  • Type: String

  • Default: 2g

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

size of /dev/shm for the container. If set, the minimum allowed value is 64m (64 megabyte).

containerBaseName

com.unblu.docker.client.containerBaseName

  • Type: String

  • Default: hb_ubuntu1804

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

base name (used for container name generation) of the container.

host

com.unblu.docker.client.host

  • Type: List of strings

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

docker host or list of hosts the client should connect to. If multiple hosts are configured then containers will be started round robin on the hosts. (e.g. http://private.docker.com, default: localhost).

portBindingAddress

com.unblu.docker.client.portBindingAddress

  • Type: String

  • Default: 0.0.0.0

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

docker host address/ip to use for container-to-host port mapping. (default: 0.0.0.0).

proxyAddress

com.unblu.docker.client.proxyAddress

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

docker proxy to use to forward connect to the docker host(s) (e.g. http://docker.unblu.com:2375).

useProxyMode

com.unblu.docker.client.useProxyMode

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Wether to run the docker client in proxy mode or not. If in proxy mode, all requests to the docker host will be processed in buffered mode rather than chunked.

HBWorkerConfiguration

headlessBrowserAudioBitRate

com.unblu.hbworker.headlessBrowserAudioBitRate

  • Type: Integer

  • Default: 64

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The bitrate for the audio encoding, in Kilobits per second

headlessBrowserVideoBitRateLowerBound

com.unblu.hbworker.headlessBrowserVideoBitRateLowerBound

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The minimum bitrate for the video encoding, in Kilobits per second. If set equal to 'headlessBrowserVideoBitRateUpperBound' it will be used as the bitrate for the CBR mode.

headlessBrowserVideoBitRateUpperBound

com.unblu.hbworker.headlessBrowserVideoBitRateUpperBound

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum bitrate for the video encoding, in Kilobits per second. If set equal to 'headlessBrowserVideoBitRateLowerBound' it will be used as the bitrate for the CBR mode.

headlessBrowserVideoFrameRate

com.unblu.hbworker.headlessBrowserVideoFrameRate

  • Type: Integer

  • Default: 30

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The maximum framerate for the video encoding and playback.

headlessBrowserVideoGPUSupport

com.unblu.hbworker.headlessBrowserVideoGPUSupport

  • Type: String with allowed values:

    • intel

    • none

    • nvidia

  • Default: NONE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether to use the software video encoder (x264), the NVIDIA HW encoder or the Intel GPU HW encoder.

headlessBrowserVideoQualityLevel

com.unblu.hbworker.headlessBrowserVideoQualityLevel

  • Type: Integer

  • Default: 28

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 69

A video quality rate factor for the resulting stream. Ranges from 0 to 69. 0 means lossless, 69 means worst.

Rendering Service information page color

SVG image background color

com.unblu.hbworker.colors.imageBackgroundColor

  • Type: Simple color

  • Default: #E9EBF4

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Background color of SVG images on information pages in the headless browser

SVG image foreground color

com.unblu.hbworker.colors.imageForegroundColor

  • Type: Simple color

  • Default: #7D87BE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Foreground color of SVG images on information pages in the headless browser

Text color

com.unblu.hbworker.colors.textColor

  • Type: Simple color

  • Default: #5c5f6a

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Text color of messages on information pages in the headless browser

HBRunnerStrategyFactory

hbPoolQueueTimeout

com.unblu.hbrunner.hbPoolQueueTimeout

  • Type: Integer

  • Default: 10

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Timeout, in seconds, to wait for rendering service instance to become available from the pool

hbPoolsize

com.unblu.hbrunner.hbPoolsize

  • Type: Integer

  • Default: 3

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

How many hbRunners should be in the pool

runnerStrategy

com.unblu.hbrunner.runnerStrategy

  • Type: String with allowed values:

    • disabled

    • hb_runner_nopool_docker

    • hb_runner_nopool_local

    • hb_runner_openshift

    • hb_runner_pool_docker

    • hb_runner_pool_local

  • Default: DISABLED

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

HeadlessBrowserRunnerStrategy

HBRpcConfiguration

connectionAttemptTimeout

com.unblu.hbrpc.connectionAttemptTimeout

  • Type: Integer

  • Default: 20

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The amount of time in seconds to wait until a GRPC connection attempt is timed out.

port

com.unblu.hbrpc.port

  • Type: Integer

  • Default: 8080

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The TCP port the GRPC server is listening to.

proxyAddress

com.unblu.hbrpc.proxyAddress

Only visible if: com.unblu.hbrpc.useProxyMode=true

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The gRPC proxy address (h2c://host:port) to connect to, if in gRPC proxy mode.

proxyPort

com.unblu.hbrpc.proxyPort

Only visible if: com.unblu.hbrpc.useProxyMode=true

  • Type: Integer

  • Default: 5080

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The gRPC proxy port, as fallback, to connect to, if in gRPC proxy mode.

retryBackoffMultiplier

com.unblu.hbrpc.retryBackoffMultiplier

  • Type: Float

  • Default: 1.5

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Backoff multiplier to be used for the randomized delay, generated from the inital backoff and the max backoff time parameters together with the actual number of attempts.

retryInitialBackoff

com.unblu.hbrpc.retryInitialBackoff

  • Type: Integer

  • Default: 500

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Initial backoff time in miliseconds for the exponential backoff retry policy.

retryMaxAttempts

com.unblu.hbrpc.retryMaxAttempts

  • Type: Integer

  • Default: 20

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum number RPC attempts, including the original request.

retryMaxBackoff

com.unblu.hbrpc.retryMaxBackoff

  • Type: Integer

  • Default: 5000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum backoff time in miliseconds for the exponential backoff retry policy.

useProxyMode

com.unblu.hbrpc.useProxyMode

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether to use gRPC with a proxy in front. This will forward the target gRPC port within a HTTP/2 header.

Universal co-browsing

Allow "chrome://" UR in universal co-browsing

com.unblu.hbworker.chromeUrlsAllowed

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

HTTP proxy exclusion rules

com.unblu.hbworker.httpProxyExcludes

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List of hosts & domains for which to bypass the proxy settings (e.g. *.unblu.com, 168.10.10.2). The format for bypass rules is described here: https://chromium.googlesource.com/chromium/src/+/HEAD/net/docs/proxy.md#Proxy-bypass-rules

Password to authenticate against forward proxy.

com.unblu.hbworker.httpProxyPassword

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

HTTP forward proxy URL settings

com.unblu.hbworker.httpProxyUrl

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The format of the URL should be <socks5|http>://[<username>:<password>@]<host>:<port>/

Username to authenticate against forward proxy

com.unblu.hbworker.httpProxyUsername

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Account secret cookie name for universal co-browsing

com.unblu.hbworker.identifierCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-account-secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Allow "javascript:" protocol in universal co-browsing

com.unblu.hbworker.javaScriptProtocolAllowed

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Allow "file:" protocol in universal co-browsing

com.unblu.hbworker.localSitesAllowed

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Allow SSL sites in universal co-browsing

com.unblu.hbworker.sslSitesAllowed

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Deny list pattern for SSL sites in universal co-browsing

com.unblu.hbworker.urls.black

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List of URL patterns for SSL sites not allowed in universal co-browsing

Universal co-browsing URL pattern evaluation order

com.unblu.hbworker.urls.order

  • Type: String

  • Default: black,white

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The evaluation order for allow/deny list URL patterns regarding SSL sites in universal co-browsing sessions

Allow list URL patterns for SSL sites in universal co-browsing

com.unblu.hbworker.urls.white

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List of URL patterns allowed for SSL sites during universal co-browsing sessions

KafkaMonitor

requestTimeoutMSConfig

com.unblu.kafka.server.requestTimeoutMSConfig

  • Type: Integer

  • Default: 500

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The timeout when connecting to the 'cluster' to determine underreplicated partitions

UnmuteVideoButtonConfiguration

Hover background color

com.unblu.mediastreaming.unmuteButton.backgroundHover

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "rendered co-browsing unmute" button in "hovered" state

Normal background color

com.unblu.mediastreaming.unmuteButton.backgroundNormal

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -20%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "rendered co-browsing unmute" button in "normal" state

Press background color

com.unblu.mediastreaming.unmuteButton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "rendered co-browsing unmute" button in "pressed" state

Hover border color

com.unblu.mediastreaming.unmuteButton.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "rendered co-browsing unmute" button in "hovered" state

Normal border color

com.unblu.mediastreaming.unmuteButton.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "rendered co-browsing unmute" button in "normal" state

Press border color

com.unblu.mediastreaming.unmuteButton.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "rendered co-browsing unmute" button in "pressed" state

Border radius

com.unblu.mediastreaming.unmuteButton.borderRadius

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the "rendered co-browsing unmute" button

Border width

com.unblu.mediastreaming.unmuteButton.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "rendered co-browsing unmute" button

Hover foreground color

com.unblu.mediastreaming.unmuteButton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "rendered co-browsing unmute" button in "hovered" state

Normal foreground color

com.unblu.mediastreaming.unmuteButton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "rendered co-browsing unmute" button in "normal" state

Press foreground color

com.unblu.mediastreaming.unmuteButton.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "rendered co-browsing unmute" button in "pressed" state

Agent mobile UI

Action bar background color

com.unblu.agent.mobile.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.agent.mobile.ui.actionBarDividerColor

  • Type: Complex color

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.agent.mobile.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.agent.mobile.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Allow "collapse" button in action bar

com.unblu.agent.mobile.ui.allowCollapseButton

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Only affects the inbox action bar if "com.unblu.agent.mobile.ui.inboxActionBarCollapseActionDisplayMode" is set to "COLLAPSE_BUTTON"

"Collapse" action display mode

com.unblu.agent.mobile.ui.inboxActionBarCollapseActionDisplayMode

  • Type: String with allowed values:

    • back_button

    • collapse_button

  • Default: BACK_BUTTON

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

To disable collapsing the agent mobile UI, set to "COLLAPSE_BUTTON" and set "com.unblu.agent.mobile.ui.allowCollapseButton" to "false"

Show inbox action bar

com.unblu.agent.mobile.ui.showInboxActionBar

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Show "collapse" action in inbox action bar

com.unblu.agent.mobile.ui.showInboxActionBarCollapseAction

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

Mobile call UI

Call UI "answer call" button border color

com.unblu.mobiledevice.call.answerCallButtonBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallAcceptButton\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI "answer call" button color

com.unblu.mobiledevice.call.answerCallButtonColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallAcceptButton\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI "answer call" icon color

com.unblu.mobiledevice.call.answerCallIconColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI background color

com.unblu.mobiledevice.call.backgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI badge border color

com.unblu.mobiledevice.call.badgeBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallTypeIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI badge color

com.unblu.mobiledevice.call.badgeColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallTypeIconBackground\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI badge icon color

com.unblu.mobiledevice.call.badgeIconColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI avatar circle border color

com.unblu.mobiledevice.call.circleBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI avatar circle color

com.unblu.mobiledevice.call.circleColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI avatar initials text color

com.unblu.mobiledevice.call.initialsTextColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI "reject call" button border color

com.unblu.mobiledevice.call.rejectCallButtonBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallDeclineButton\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI "reject call" button color

com.unblu.mobiledevice.call.rejectCallButtonColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.call.colorCallDeclineButton\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI "reject call" icon color

com.unblu.mobiledevice.call.rejectCallIconColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Call UI text color

com.unblu.mobiledevice.call.textColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

MobileCoBrowsingIndicatorConfiguration

mobileCoBrowsingFrameShadowColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingFrameShadowColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundInverse\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color value for the mobile co-browsing indicator frame shadow

mobileCoBrowsingFrameShadowSize

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingFrameShadowSize

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Size(dip) for the mobile co-browsing indicator frame shadow

mobileCoBrowsingFrameWidth

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingFrameWidth

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width, in dp (Android) or points (iOS), of the mobile co-browsing indicator’s frame

mobileCoBrowsingIndicatorBorderColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.conversation.collabspace.colorVisitorCapturingFrame\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Border color of the mobile co-browsing indicator and frame

mobileCoBrowsingIndicatorButtonBackgroundColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the mobile co-browsing indicator button

mobileCoBrowsingIndicatorButtonIconColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonIconColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the mobile co-browsing indicator icon

mobileCoBrowsingIndicatorButtonInitialHorizontalMargin

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonInitialHorizontalMargin

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width, in pixels, of the horizontal margin of the mobile co-browsing indicator’s shadow

mobileCoBrowsingIndicatorButtonInitialPosition

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonInitialPosition

  • Type: String with allowed values:

    • bottom_left

    • bottom_right

    • top_left

    • top_right

  • Default: TOP_LEFT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Value for the initial position of the mobile co-browsing indicator

mobileCoBrowsingIndicatorButtonInitialVerticalMargin

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonInitialVerticalMargin

  • Type: Integer

  • Default: 100

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width, in pixels, of the vertical margin of the mobile co-browsing indicator’s shadow

mobileCoBrowsingIndicatorButtonShadowColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonShadowColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundInverse\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the mobile co-browsing indicator’s shadow

mobileCoBrowsingIndicatorButtonShadowSize

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingIndicatorButtonShadowSize

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Width, in dp (Android) or points (iOS), of the mobile co-browsing indicator’s shadow

mobileCoBrowsingPopUpMenuBackgroundColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingPopUpMenuBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Background color of the mobile co-browsing popup menu (Android)

mobileCoBrowsingPopUpMenuTextColor

com.unblu.mobiledevice.v2.client.core.mobileCoBrowsingPopUpMenuTextColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundInverse\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text color of the mobile co-browsing popup menu (Android)

Mobile device configuration

Highest-quality compression rate (Android)

com.unblu.mobiledevice.androidCompressionQualityMaxRate

  • Type: Float

  • Default: 0.8

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 1

The highest quality compression rate for Android devices. The value must be between 0.0 and 1.0.

Lowest-quality compression rate (Android)

com.unblu.mobiledevice.androidCompressionQualityMinRate

  • Type: Float

  • Default: 0.1

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 1

The lowest quality compression rate for Android devices. The value must be between 0.0 and 1.0.

Create tiles for Android visual transmission

com.unblu.mobiledevice.androidDoCreateTiles

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If 'true', Android devices will send tiles instead of a whole image.

Maximum capturing rate for android devices

com.unblu.mobiledevice.androidMaxFpsRate

  • Type: Float

  • Default: 5.0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Maximum capturing rate for android devices.

Background color of mobile loading screen

com.unblu.mobiledevice.colorLoaderBackground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundMid\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Background color of the mobile loading screen for the Unblu functionality provided through the SDK

Foreground color of mobile loading screen

com.unblu.mobiledevice.colorLoaderForeground

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Foreground color of the mobile loading screen for the Unblu functionality provided through the SDK

Highest-quality compression rate (iOS)

com.unblu.mobiledevice.iosCompressionQualityMaxRate

  • Type: Float

  • Default: 0.8

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 1

The highest quality compression rate for iOS devices. The value must be between 0.0 and 1.0.

Lowest-quality compression rate (iOS)

com.unblu.mobiledevice.iosCompressionQualityMinRate

  • Type: Float

  • Default: 0.0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

    • Maximum value: 1

The lowest quality compression rate for iOS devices. The value must be between 0.0 and 1.0.

Create tiles for iOS visual transmission

com.unblu.mobiledevice.iosDoCreateTiles

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If 'true', iOS devices will send tiles instead of a whole image.

Maximum capture rate in FPS (iOS)

com.unblu.mobiledevice.iosMaxFpsRate

  • Type: Float

  • Default: 5.0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Maximum capture rate in frames per second (FPS) for iOS devices

Make device API available

com.unblu.mobiledevice.makeDeviceApiAvailable

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Make the DeviceApi object visible in the window element. This can be useful when debugging.

Enable mock device

com.unblu.mobiledevice.mockDeviceEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set to true to enable the mock device, which "works" in normal browsers.

Set number of pixels for mobile phone capturing

com.unblu.mobiledevice.phoneMaxPixelPerTileSide

  • Type: Integer

  • Default: 64

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The number of pixels per side of each tile, when capturing on a phone.

Maximum Resolution Phone Height

com.unblu.mobiledevice.phoneMaxResolutionHeight

  • Type: Integer

  • Default: 768

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum height of the resolution for phones. It is only considered if a device is bigger then this value.

Maximum Resolution Phone Width

com.unblu.mobiledevice.phoneMaxResolutionWidth

  • Type: Integer

  • Default: 432

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum width of the resolution for phones. It is only considered if a device is bigger then this value.

Set number of pixels for tablet capturing

com.unblu.mobiledevice.tabletMaxPixelPerTileSide

  • Type: Integer

  • Default: 128

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The number of pixels per side of each tile, when capturing on a tablet.

Maximum tablet height resolution

com.unblu.mobiledevice.tabletMaxResolutionHeight

  • Type: Integer

  • Default: 1024

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum height of the resolution for tablets. It is only considered if a device is bigger then this value.

Maximum tablet width resolution

com.unblu.mobiledevice.tabletMaxResolutionWidth

  • Type: Integer

  • Default: 768

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum width of the resolution for tablets. It is only considered if a device is bigger then this value.

Mobile device file chooser

Background color of camera activity buttons (Android)

com.unblu.mobiledevice.filechooser.cameraActivityButtonBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used in the camera activity for the chat functionality provided through the Android SDK

Border color of camera activity buttons (Android)

com.unblu.mobiledevice.filechooser.cameraActivityButtonBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used in the camera activity for the chat functionality provided through the Android mobile SDK

Foreground color of camera activity buttons (Android)

com.unblu.mobiledevice.filechooser.cameraActivityButtonForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used in the camera activity for the chat functionality provided through the Android mobile SDK

Color of camera activity "capture" button (Android)

com.unblu.mobiledevice.filechooser.cameraActivityCaptureButtonColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used in the camera activity for the chat functionality provided through the Android mobile SDK

Background color (Android)

com.unblu.mobiledevice.filechooser.fileChooserBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used in the file chooser menu of the Unblu chat functionality provided through the Android mobile SDK

Button background color (Android)

com.unblu.mobiledevice.filechooser.fileChooserButtonBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for buttons in the file chooser menu of the chat functionality provided through the Android mobile SDK

Button border color (Android)

com.unblu.mobiledevice.filechooser.fileChooserButtonBorderColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for buttons in the file chooser menu of the chat functionality provided through the Android mobile SDK

Button border width (Android)

com.unblu.mobiledevice.filechooser.fileChooserButtonBorderWidth

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for buttons in the file chooser menu of the chat functionality provided through the Android mobile SDK

Button foreground color (Android)

com.unblu.mobiledevice.filechooser.fileChooserButtonForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for buttons in the file chooser menu of the chat functionality provided through the Android mobile SDK

Title text color (Android)

com.unblu.mobiledevice.filechooser.fileChooserTitleTextColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for the title of the file chooser menu in the chat functionality provided through the Android SDK

Mobile device mock configuration (developer only)

Mock device image

com.unblu.mobiledevice.v2.client.core.api.bridge.MockMobileDeviceBridgeBase.mockDeviceImage

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Image which is displayed for the mock device encoded in base64 (without prefix of type)

Visitor mobile UI

Action bar background color

com.unblu.visitor.mobile.ui.actionBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Set to "transparent" to let a custom background shine through. If set to "transparent", make sure that "actionBarForeground" is set to "DARK" or "LIGHT", as "AUTO" won’t work in this case.

Action bar divider color

com.unblu.visitor.mobile.ui.actionBarDividerColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Used at the bottom of the action bar. Only relevant if actionBarElevation is set to "FLAT".

Action bar elevation

com.unblu.visitor.mobile.ui.actionBarElevation

  • Type: String with allowed values:

    • elevated

    • flat

  • Default: ELEVATED

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

"FLAT" displays a divider beneath the action bar and no shadow. "ELEVATED" displays a shadow beneath the action bar and no divider.

Action bar foreground brightness

com.unblu.visitor.mobile.ui.actionBarForeground

  • Type: String with allowed values:

    • auto

    • dark

    • light

  • Default: AUTO

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

When set to "AUTO", the foreground color is selected based on the action bar’s background color to guarantee maximum contrast

Allow "collapse" button in action bar

com.unblu.visitor.mobile.ui.allowCollapseButton

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

Only affects the overview action bar if "com.unblu.visitor.mobile.ui.overviewActionBarCollapseActionDisplayMode" is set to "COLLAPSE_BUTTON"

Display mode of "collapse" action in overview action bar

com.unblu.visitor.mobile.ui.overviewActionBarCollapseActionDisplayMode

  • Type: String with allowed values:

    • back_button

    • collapse_button

  • Default: BACK_BUTTON

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

If set to "COLLAPSE_BUTTON", "com.unblu.visitor.ui.showOverviewActionBarCollapseAction" must be "true" for the button to be displayed. To disable collapsing the visitor mobile UI, set to "COLLAPSE_BUTTON" and set "com.unblu.visitor.mobile.ui.allowCollapseButton" to "false".

Mobile push notification configuration

Agent app bundle ID

com.unblu.mobile.push_notification.apnsAgentPushKitBundleId

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Your agent app’s bundle ID. Used for iOS APNs push notifications.

APNs key ID

com.unblu.mobile.push_notification.apnsKeyId

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Key ID

Visitor app bundle ID

com.unblu.mobile.push_notification.apnsPushKitBundleId

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Your visitor app’s bundle ID. Used for iOS APNs push notifications.

APNs authentication key

com.unblu.mobile.push_notification.apnsPushKitKey

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: -----BEGIN PRIVATE KEY-----[^-]+-----END PRIVATE KEY-----

APNs authentication key. The key must be the certificate’s private key in PEM format (with BEGIN PRIVATE KEY and END PRIVATE KEY lines).

APNs team ID

com.unblu.mobile.push_notification.apnsTeamId

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Team ID

Send iOS notifications with APNs

com.unblu.mobile.push_notification.enableApnsForAllNotifications

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, notifications for iOS devices are sent directly to APNs instead of using Firebase. Only relevant if enableFirebasePushNotification is "true".

Enable APNs production endpoint

com.unblu.mobile.push_notification.enableApnsProductionEndpoint

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether the APNs endpoint is a production endpoint. If set to 'false', a development sandbox is used.

Enable PushKit call notifications via APNs

com.unblu.mobile.push_notification.enableApnsPushKitCallNotification

Only visible if: com.unblu.core.push_notification.enablePushNotification=true, com.unblu.mobile.push_notification.enableFirebasePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable PushKit call notifications via APNs. Only relevant for iOS.

Enable push notifications via Firebase

com.unblu.mobile.push_notification.enableFirebasePushNotification

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable Firebase push notifications for Android, iOS, and browsers. If enableApnsForAllNotifications is "true", all push notifications for iOS are sent to directly APNs instead of Firebase.

Firebase project ID

com.unblu.mobile.push_notification.firebaseDatabaseName

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The ID of the firebase project where the app is configured for Firebase Cloud Messaging. Set the property to the Project ID of your Firebase project, as displayed on the "General" tab of your Firebase project’s settings.

Firebase service account key

com.unblu.mobile.push_notification.firebaseServiceAccountKey

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Matches regular expression: ^\s*(\{\}|\[[\s\S]\])\s*$

The contents of the .json file for the Firebase cloud messaging service account key

Proxy URL for Firebase server access

com.unblu.mobile.push_notification.proxyUrl

Only visible if: com.unblu.core.push_notification.enablePushNotification=true

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Proxy server URL to be used by the Unblu server to access the Firebase server. Supported format: http:[<username>:<password>@]<host>:<port> (no other protocols). Currently, only basic authentication is supported.

if you use Java 8 update 111 or newer, you must start the JVM with -Djdk.http.auth.tunneling.disabledSchemes="", or the proxy will NOT be used.

Mobile push notifications

Android "incoming call" sound

com.unblu.mobile.push_notification.androidIncomingCallSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file to play as an "Incoming call" notification. Example: incoming_call. Only used by Android. The file must be present in the corresponding app. If not specified, the default system sound will be used.

This configuration property will only have an effect on versions of Android before Oreo (8.0). Oreo and newer versions will use the device’s default notification sound.

"Missed call" audio file (Android)

com.unblu.mobile.push_notification.androidMissedCallSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file to play as a "missed call" notification. Example: missed_call. Only used by Android. The file must be present in the corresponding app. If not specified, the default system sound will be used.

This configuration property will only have an effect on versions of Android before Oreo (8.0). Oreo and newer will use the device’s default notification sound.

Android "new message" sound

com.unblu.mobile.push_notification.androidNewMessageSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file to play as a new message notification. Example: new_message. Only used by Android. The file must be present in the corresponding app. If not specified, the default system sound will be used.

This configuration property will only have an effect on versions of Android before Oreo (8.0). Oreo and newer versions will use the device’s default notification sound.

iOS "incoming call" sound

com.unblu.mobile.push_notification.iOSIncomingCallSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file which should be played as an "Incoming call" notification. Example: incoming_call.wav. The file has to be present in the corresponding app. If no file is specified, the system’s default sound is used. This setting is for iOS only.

"Missed call" audio file (iOS)

com.unblu.mobile.push_notification.iOSMissedCallSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file to play as a "missed call" notification. Example: missed_call.wav. Only used by iOS. The file must be present in the corresponding app. If not specified, the default system sound will be used.

iOS "new message" sound

com.unblu.mobile.push_notification.iOSNewMessageSound

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Name of the audio file which should be played as a "New message" notification. Example: new_message.wav. The file has to be present in the corresponding app. If no file is specified, the system’s default sound is used. This setting is for iOS only.

ID for call notificationChannel (Android only)

com.unblu.mobile.push_notification.incomingCallNotificationChannelId

  • Type: String

  • Default: INCOMING_CALLS

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

ID for missed call notificationChannel (Android only)

com.unblu.mobile.push_notification.missedCallNotificationChannelId

  • Type: String

  • Default: MISSED_CALLS

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

ID for message notificationChannel (Android only)

com.unblu.mobile.push_notification.newMessageNotificationChannelId

  • Type: String

  • Default: NEW_MESSAGES

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

TeamsIntegrationConfiguration

MS Teams notification audio call icon background color

com.unblu.msteams.audioCallIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #c4f1b5

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Client secret for MS Teams bot

com.unblu.msteams.botApiClientSecret

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The client secret configured for the MS Teams bot to send notifications to customers

MS Teams notification chat icon background color

com.unblu.msteams.chatIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #e9bde0

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MS Teams notification co-browsing icon background color

com.unblu.msteams.cobrowsingIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #fecfb9

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MS Teams endpoint connection timeout (in ms)

com.unblu.msteams.connectTimeout

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Integer

  • Default: 2000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The Unblu Server cancels the message delivery request if the timeout is reached

Enable MS Teams push notifications

com.unblu.msteams.enableTeamsBotPushNotifications

Only visible if: com.unblu.core.push_notification.enablePushNotification=true, com.unblu.msteams.enableTeamsIntegration=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Push notifications for MS Teams are sent via a Teams notification bot

Enable MS Teams integration

com.unblu.msteams.enableTeamsIntegration

Only visible if: com.unblu.platform.enablePreview=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, you must set all the other configuration properties in the group for the integration to work correctly

MS Teams notification forwarding icon background color

com.unblu.msteams.forwardingIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #ffc1cb

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MS Teams notification invitation icon background color

com.unblu.msteams.invitationIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #fff0c2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MS Teams notification missed call icon background color

com.unblu.msteams.missedCallIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #D1001B

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL for MS Teams JavaScript SDK URL

com.unblu.msteams.msTeamsJsSdkUrl

Only visible if: com.unblu.msteams.enableTeamsIntegration=true

The SDK will be loaded inside the MS Teams entry points of Unblu. It is used to access features specific to MS Teams, for example, the user’s Teams identity or the Unblu conversation to open from within the Unblu iframe.

Proxy URL for MS Teams endpoint

com.unblu.msteams.proxyUrl

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The proxy URL the Unblu Server must use to access the MS Teams endpoint. Supported format: http(s)://<host>:<port> (no authentication, no other protocols).

User agent for delivering MS Teams notifications

com.unblu.msteams.requestUserAgent

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: String

  • Default: Unblu-MsTeamsClient

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

MS Teams message delivery request timeout (in ms)

com.unblu.msteams.responseTimeout

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Integer

  • Default: 10000

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The Unblu Server cancels the message delivery request if the timeout is reached

App ID of Unblu MS Teams app

com.unblu.msteams.unbluAppId

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The ID of the app Unblu is wrapped in. This is not the MS Teams bot app ID. It is used to generate deep links in notifications.

MS Teams notification video call icon background color

com.unblu.msteams.videoCallIconBackgroundColor

Only visible if: com.unblu.msteams.enableTeamsBotPushNotifications=true

  • Type: Simple color

  • Default: #b9ddf2

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Window state service

Mechanism to store a tab’s or window’s Unblu state

com.unblu.windowstate.windowStateStoreType

  • Type: String with allowed values:

    • session_storage

    • window_name

  • Default: WINDOW_NAME

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Using the window name is the more powerful solution as it lets you maintain state even when navigating between different domains. However, if the window name is being used by another application, this can cause integration issues, and it may make sense to use session storage instead.

General UI configuration

Default animation duration (in s)

com.unblu.ui.animationDuration

  • Type: Float

  • Default: 0.3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Default animation function

com.unblu.ui.animationFunction

  • Type: String with allowed values:

    • bounce

    • ease

    • ease_in

    • ease_in_out

    • ease_out

    • linear

  • Default: EASE_IN_OUT

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Default border radius (in px)

com.unblu.ui.borderRadiusComponent

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used on UI elements such as speech bubbles

JavaScript layouting rules

com.unblu.ui.forceJSLayoutForBrowsers

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Comma-separated list of browsers that should always use JavaScript layouting Possible values are EDGE, FIREFOX, CHROME, SAFARI…​ as defined in JSTK.UserAgent

Grid spacing size 16px

com.unblu.ui.gridSpacing16

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 24px

com.unblu.ui.gridSpacing24

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 32px

com.unblu.ui.gridSpacing32

  • Type: Integer

  • Default: 32

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 4px

com.unblu.ui.gridSpacing4

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 40px

com.unblu.ui.gridSpacing40

  • Type: Integer

  • Default: 40

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 48px

com.unblu.ui.gridSpacing48

  • Type: Integer

  • Default: 48

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Grid spacing size 8px

com.unblu.ui.gridSpacing8

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

MarkdownDefaultStyleConfiguration

codeBackgroundColor

com.unblu.markdown.style.codeBackgroundColor

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral\},$alpha: 0.08)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for backround of both inline and block code elements

codeFontColor

com.unblu.markdown.style.codeFontColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray800\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for font of both inline and block code elements

linkFontColor

com.unblu.markdown.style.linkFontColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for font of links, also when hovered

quoteLineColor

com.unblu.markdown.style.quoteLineColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color of the line next to a quoted text

Responsive UI service

Responsive UI extra large break point

com.unblu.ui.responsive.extraLargeBreakPoint

  • Type: Integer

  • Default: 1200

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum device width that should be regarded as an extra large device (normal computer)

Responsive UI extra small break point

com.unblu.ui.responsive.extraSmallBreakPoint

  • Type: Integer

  • Default: 0

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum device width that should be regarded as an extra-small device (small mobile phone)

Responsive UI large break point

com.unblu.ui.responsive.largeBreakPoint

  • Type: Integer

  • Default: 992

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum device width that should be regarded as a large device (large tablet / small computer).

Responsive UI medium break point

com.unblu.ui.responsive.mediumBreakPoint

  • Type: Integer

  • Default: 768

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum device width that should be regarded as a medium device (tablet).

Small break point

com.unblu.ui.responsive.smallBreakPoint

  • Type: Integer

  • Default: 544

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Minimum device width that should be regarded as a small device (large mobile phone / small tablet).

Color theme (base colors)

Announcement color variant 100

com.unblu.theme.color.announcement100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement200\}, $lightness: 10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 200

com.unblu.theme.color.announcement200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement300\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 300

com.unblu.theme.color.announcement300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement400\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 400

com.unblu.theme.color.announcement400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement500\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 500

com.unblu.theme.color.announcement500

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightAnnouncement\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 600

com.unblu.theme.color.announcement600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement500\}, $lightness: -9%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 700

com.unblu.theme.color.announcement700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement600\}, $lightness: -9%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 800

com.unblu.theme.color.announcement800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement700\}, $lightness: -9%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Announcement color variant 900

com.unblu.theme.color.announcement900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.announcement800\}, $lightness: -5%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for inverse, dark backgrounds

com.unblu.theme.color.backgroundInverse

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text is displayed inverse on this background

Color for inverse, medium backgrounds

com.unblu.theme.color.backgroundInverseMid

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Text is displayed inverse on this background

Color for light backgrounds

com.unblu.theme.color.backgroundLight

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for medium backgrounds

com.unblu.theme.color.backgroundMid

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for borders and separators

com.unblu.theme.color.border

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 100

com.unblu.theme.color.error100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error200\}, $lightness: 6%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 200

com.unblu.theme.color.error200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error300\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 300

com.unblu.theme.color.error300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error400\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 400

com.unblu.theme.color.error400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error500\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 500

com.unblu.theme.color.error500

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 600

com.unblu.theme.color.error600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error500\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 700

com.unblu.theme.color.error700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error600\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 800

com.unblu.theme.color.error800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error700\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Error color variant 900

com.unblu.theme.color.error900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.error800\}, $lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color to highlight focused areas and inputs

com.unblu.theme.color.focus

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Main gray color

com.unblu.theme.color.gray

  • Type: Simple color

  • Default: #6f7280

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

All gray shades for backgrounds, borders etc. are derived from this color. This should be a medium lightness color from which darker and lighter shades can be derived.

Gray color variant 50

com.unblu.theme.color.gray050

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray100\},$lightness: 10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 100

com.unblu.theme.color.gray100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray200\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 200

com.unblu.theme.color.gray200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray300\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 300

com.unblu.theme.color.gray300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray400\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 400

com.unblu.theme.color.gray400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray500\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 500

com.unblu.theme.color.gray500

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray600\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 600

com.unblu.theme.color.gray600

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 700

com.unblu.theme.color.gray700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray600\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 800

com.unblu.theme.color.gray800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray700\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Gray color variant 900

com.unblu.theme.color.gray900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray800\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for highlights and informational announcements

com.unblu.theme.color.highlightAnnouncement

  • Type: Simple color

  • Default: #006CBD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for errors

com.unblu.theme.color.highlightError

  • Type: Simple color

  • Default: #FF1432

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for successful actions

com.unblu.theme.color.highlightSuccess

  • Type: Simple color

  • Default: #00CC66

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color for warnings

com.unblu.theme.color.highlightWarning

  • Type: Simple color

  • Default: #FFC419

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Main neutral color

com.unblu.theme.color.neutral

  • Type: Simple color

  • Default: #404A80

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for backgrounds such as modal dialog backdrops. This should be a very dark color, as the text displayed on it is white.

Neutral color variant 50

com.unblu.theme.color.neutral050

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral100\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 100

com.unblu.theme.color.neutral100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral200\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 200

com.unblu.theme.color.neutral200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral300\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 300

com.unblu.theme.color.neutral300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral400\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 400

com.unblu.theme.color.neutral400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral500\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 500

com.unblu.theme.color.neutral500

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral600\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 600

com.unblu.theme.color.neutral600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral700\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 700

com.unblu.theme.color.neutral700

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 800

com.unblu.theme.color.neutral800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral700\},$lightness: -3%, $saturation: 10%))

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Neutral color variant 900

com.unblu.theme.color.neutral900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.neutral700\},$lightness: -6%, $saturation: 20%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Main primary color

com.unblu.theme.color.primary

  • Type: Simple color

  • Default: #fa6019

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used mainly for highlighting primary actions and active sections. This should be a light, highly saturated color. Text displayed on it is white.

Primary color variant 50

com.unblu.theme.color.primary050

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary100\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 100

com.unblu.theme.color.primary100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary200\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 200

com.unblu.theme.color.primary200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary300\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 300

com.unblu.theme.color.primary300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary400\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 400

com.unblu.theme.color.primary400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary500\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 500

com.unblu.theme.color.primary500

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 600

com.unblu.theme.color.primary600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary500\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 700

com.unblu.theme.color.primary700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary600\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 800

com.unblu.theme.color.primary800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary700\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Primary color variant 900

com.unblu.theme.color.primary900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.primary800\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Main secondary accent color variant

com.unblu.theme.color.secondary

  • Type: Simple color

  • Default: #73bbe6

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

This should be a medium light, strong saturated color. Text on it is displayed in white.

Secondary color variant 50

com.unblu.theme.color.secondary050

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary100\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 100

com.unblu.theme.color.secondary100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary200\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 200

com.unblu.theme.color.secondary200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary300\},$lightness: 8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 300

com.unblu.theme.color.secondary300

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 400

com.unblu.theme.color.secondary400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary300\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 500

com.unblu.theme.color.secondary500

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary400\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 600

com.unblu.theme.color.secondary600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary500\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 700

com.unblu.theme.color.secondary700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary600\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 800

com.unblu.theme.color.secondary800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary700\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Secondary color variant 900

com.unblu.theme.color.secondary900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.secondary800\},$lightness: -8%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Base color used for shadows

com.unblu.theme.color.shadow

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\},$alpha: 0.25)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 100

com.unblu.theme.color.success100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success200\}, $lightness: 9%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 200

com.unblu.theme.color.success200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success300\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 300

com.unblu.theme.color.success300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success400\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 400

com.unblu.theme.color.success400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success500\}, $lightness: 15%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 500

com.unblu.theme.color.success500

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 600

com.unblu.theme.color.success600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success500\}, $lightness: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 700

com.unblu.theme.color.success700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success600\}, $lightness: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 800

com.unblu.theme.color.success800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success700\}, $lightness: -6%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Success color variant 900

com.unblu.theme.color.success900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.success800\}, $lightness: -6%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 100

com.unblu.theme.color.warning100

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning200\}, $lightness: 7%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 200

com.unblu.theme.color.warning200

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning300\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 300

com.unblu.theme.color.warning300

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning400\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 400

com.unblu.theme.color.warning400

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning500\}, $lightness: 11%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 500

com.unblu.theme.color.warning500

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightWarning\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 600

com.unblu.theme.color.warning600

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning500\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 700

com.unblu.theme.color.warning700

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning600\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 800

com.unblu.theme.color.warning800

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning700\}, $lightness: -13%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Warning color variant 900

com.unblu.theme.color.warning900

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.warning800\}, $lightness: -9%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Input field style

Background color

com.unblu.theme.input.backgroundColor

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Border color

com.unblu.theme.input.borderColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

"Error" border color

com.unblu.theme.input.borderColorError

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightError\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

"Focus" border color

com.unblu.theme.input.borderColorFocus

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.focus\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

"Success" border color

com.unblu.theme.input.borderColorValid

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.highlightSuccess\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Border radius

com.unblu.theme.input.borderRadius

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Background color of active radio buttons and checkboxes

com.unblu.theme.input.checkedActiveBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary300\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Foreground color of active radio buttons and checkboxes

com.unblu.theme.input.checkedActiveForegroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Font color

com.unblu.theme.input.fontColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: LINK_DARK

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Font size

com.unblu.theme.input.fontSize

  • Type: String with allowed values:

    • heading1

    • heading2

    • heading3

    • paragraph

    • small

    • tiny

  • Default: PARAGRAPH

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Font weight

com.unblu.theme.input.fontWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: NORMAL

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Line height

com.unblu.theme.input.lineHeight

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Horizontal padding

com.unblu.theme.input.paddingHorizontal

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Vertical padding

com.unblu.theme.input.paddingVertical

  • Type: Integer

  • Default: 5

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Affects the input fields in all Unblu UIs (Agent Desk, Account Configuration interface, Global Server Configuration interface, and Visitor UIs). The input field for chat messages isn’t affected.

Base style shared by all buttons

Border radius

com.unblu.theme.button.borderRadius

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all buttons

Font weight

com.unblu.theme.button.fontWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: SEMIBOLD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used by all buttons

Horizontal padding for "large" buttons

com.unblu.theme.button.horizontalPaddingButtonLarge

  • Type: Integer

  • Default: 15

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "large" buttons

Horizontal padding for "small" buttons

com.unblu.theme.button.horizontalPaddingButtonSmall

  • Type: Integer

  • Default: 7

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "small" buttons

Horizontal padding for "standard"-sized buttons

com.unblu.theme.button.horizontalPaddingButtonStandard

  • Type: Integer

  • Default: 15

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "standard" buttons

Horizontal padding for "tiny" buttons

com.unblu.theme.button.horizontalPaddingButtonTiny

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "tiny" buttons

Line height

com.unblu.theme.button.lineHeight

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all buttons

Horizontal and vertical padding for "large" icon buttons

com.unblu.theme.button.paddingIconButtonLarge

  • Type: Integer

  • Default: 8

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "large" icon buttons

Horizontal and vertical padding for "small" icon buttons

com.unblu.theme.button.paddingIconButtonSmall

  • Type: Integer

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "small" icon buttons

Horizontal and vertical padding for "standard" icon buttons

com.unblu.theme.button.paddingIconButtonStandard

  • Type: Integer

  • Default: 4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "standard" icon buttons

Horizontal and vertical padding for "tiny" icon buttons

com.unblu.theme.button.paddingIconButtonTiny

  • Type: Integer

  • Default: 2

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "tiny" icon buttons

Vertical padding for "large" buttons

com.unblu.theme.button.verticalPaddingButtonLarge

  • Type: Integer

  • Default: 11

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Vertical padding for "small" buttons

com.unblu.theme.button.verticalPaddingButtonSmall

  • Type: Integer

  • Default: 3

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "small" buttons

Vertical padding for "standard"-sized buttons

com.unblu.theme.button.verticalPaddingButtonStandard

  • Type: Integer

  • Default: 7

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "standard" buttons

Vertical padding for "tiny" buttons

com.unblu.theme.button.verticalPaddingButtonTiny

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used by all "tiny" buttons

"Critical" action button style

"Hovered" background color

com.unblu.theme.button.critical.backgroundHover

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightError\},$lightness: -25%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "critical action" button in "hovered" state

Normal background color

com.unblu.theme.button.critical.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "critical action" button in "normal" state

"Pressed" background color

com.unblu.theme.button.critical.backgroundPress

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightError\},$lightness: -35%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "critical action" button in "pressed" state

"Hovered" border color

com.unblu.theme.button.critical.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "critical action" button in "hovered" state

Normal border color

com.unblu.theme.button.critical.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "critical action" button in "normal" state

"Pressed" border color

com.unblu.theme.button.critical.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "critical action" button in "pressed" state

Border width

com.unblu.theme.button.critical.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "critical action" button

"Hovered" foreground color

com.unblu.theme.button.critical.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "critical action" button in "hovered" state

Normal foreground color

com.unblu.theme.button.critical.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "critical action" button in "normal" state

"Pressed" foreground color

com.unblu.theme.button.critical.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "critical action" button in "pressed" state

Flat inverse button style

"Hovered" background color

com.unblu.theme.button.flat.inverse.backgroundHover

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.backgroundLight\},$alpha: 0.1)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat inverse" button in "hovered" state

Normal background color

com.unblu.theme.button.flat.inverse.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat inverse" button in "normal" state

"Pressed" background color

com.unblu.theme.button.flat.inverse.backgroundPress

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.backgroundLight\},$alpha: 0.2)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat inverse" button in "pressed" state

"Hovered" border color

com.unblu.theme.button.flat.inverse.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat inverse" button in "hovered" state

Normal border color

com.unblu.theme.button.flat.inverse.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat inverse" button in "normal" state

"Pressed" border color

com.unblu.theme.button.flat.inverse.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat inverse" button in "pressed" state

Border width

com.unblu.theme.button.flat.inverse.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "flat inverse" button

"Hovered" foreground color

com.unblu.theme.button.flat.inverse.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat inverse" button in "hovered" state

Normal foreground color

com.unblu.theme.button.flat.inverse.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat inverse" button in "normal" state

"Pressed" foreground color

com.unblu.theme.button.flat.inverse.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat inverse" button in "pressed" state

Flat primary button style

"Hovered" background color

com.unblu.theme.button.flat.primary.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary" button in "hovered" state

Normal background color

com.unblu.theme.button.flat.primary.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary" button in "normal" state

"Pressed" background color

com.unblu.theme.button.flat.primary.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary" button in "pressed" state

"Hovered" border color

com.unblu.theme.button.flat.primary.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary" button in "hovered" state

Normal border color

com.unblu.theme.button.flat.primary.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary" button in "normal" state

"Pressed" border color

com.unblu.theme.button.flat.primary.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary" button in "pressed" state

Border width

com.unblu.theme.button.flat.primary.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "flat primary" button

"Hovered" foreground color

com.unblu.theme.button.flat.primary.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary" button in "hovered" state

Normal foreground color

com.unblu.theme.button.flat.primary.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary" button in "normal" state

"Pressed" foreground color

com.unblu.theme.button.flat.primary.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary" button in "pressed" state

Flat primary toggle button style

"Hovered" background color

com.unblu.theme.button.toggle.flat.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "hovered" state

"Hovered" background color (active)

com.unblu.theme.button.toggle.flat.backgroundHoverActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.secondary100\}, $alpha: 0.72)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "hovered (active)" state

Normal background color

com.unblu.theme.button.toggle.flat.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "normal" state

Normal background color (active)

com.unblu.theme.button.toggle.flat.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "normal (active)" state

"Pressed" background color

com.unblu.theme.button.toggle.flat.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "pressed" state

"Pressed" background color (active)

com.unblu.theme.button.toggle.flat.backgroundPressActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.secondary100\}, $alpha: 0.8)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat primary toggle" button in "pressed (active)" state

"Hovered" border color

com.unblu.theme.button.toggle.flat.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "hovered" state

"Hovered" border color (active)

com.unblu.theme.button.toggle.flat.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "hovered (active)" state

Normal border color

com.unblu.theme.button.toggle.flat.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "normal" state

Normal border color (active)

com.unblu.theme.button.toggle.flat.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "normal (active)" state

"Pressed" border color

com.unblu.theme.button.toggle.flat.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "pressed" state

"Pressed" border color (active)

com.unblu.theme.button.toggle.flat.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat primary toggle" button in "pressed (active)" state

Border width

com.unblu.theme.button.toggle.flat.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "flat primary toggle" button

"Hovered" foreground color

com.unblu.theme.button.toggle.flat.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.theme.button.toggle.flat.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "hovered (active)" state

Normal foreground color

com.unblu.theme.button.toggle.flat.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "normal" state

Normal foreground color (active)

com.unblu.theme.button.toggle.flat.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "normal (active)" state

"Pressed" foreground color

com.unblu.theme.button.toggle.flat.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.primary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.theme.button.toggle.flat.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat primary toggle" button in "pressed (active)" state

Flat secondary button style

"Hovered" background color

com.unblu.theme.button.flat.secondary.backgroundHover

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.08)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary" button in "hovered" state

Normal background color

com.unblu.theme.button.flat.secondary.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary" button in "normal" state

"Pressed" background color

com.unblu.theme.button.flat.secondary.backgroundPress

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.16)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary" button in "pressed" state

"Hovered" border color

com.unblu.theme.button.flat.secondary.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary" button in "hovered" state

Normal border color

com.unblu.theme.button.flat.secondary.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary" button in "normal" state

"Pressed" border color

com.unblu.theme.button.flat.secondary.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary" button in "pressed" state

Border width

com.unblu.theme.button.flat.secondary.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "flat secondary" button

"Hovered" foreground color

com.unblu.theme.button.flat.secondary.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary" button in "hovered" state

Normal foreground color

com.unblu.theme.button.flat.secondary.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary" button in "normal" state

"Pressed" foreground color

com.unblu.theme.button.flat.secondary.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary" button in "pressed" state

Flat secondary toggle button style

"Hovered" background color

com.unblu.theme.button.toggle.flat.secondary.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "hovered" state

"Hovered" background color (active)

com.unblu.theme.button.toggle.flat.secondary.backgroundHoverActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.32)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "hovered (active)" state

Normal background color

com.unblu.theme.button.toggle.flat.secondary.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "normal" state

Normal background color (active)

com.unblu.theme.button.toggle.flat.secondary.backgroundNormalActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.24)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "normal (active)" state

"Pressed" background color

com.unblu.theme.button.toggle.flat.secondary.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "pressed" state

"Pressed" background color (active)

com.unblu.theme.button.toggle.flat.secondary.backgroundPressActive

  • Type: Complex color

  • Default: change-color($\{com.unblu.theme.color.neutral700\}, $alpha: 0.4)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "flat secondary toggle" button in "pressed (active)" state

"Hovered" border color

com.unblu.theme.button.toggle.flat.secondary.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "hovered" state

"Hovered" border color (active)

com.unblu.theme.button.toggle.flat.secondary.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "hovered (active)" state

Normal border color

com.unblu.theme.button.toggle.flat.secondary.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "normal" state

Normal border color (active)

com.unblu.theme.button.toggle.flat.secondary.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "normal (active)" state

"Pressed" border color

com.unblu.theme.button.toggle.flat.secondary.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "pressed" state

"Pressed" border color (active)

com.unblu.theme.button.toggle.flat.secondary.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "flat secondary toggle" button in "pressed (active)" state

Border width

com.unblu.theme.button.toggle.flat.secondary.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "flat secondary toggle" button

"Hovered" foreground color

com.unblu.theme.button.toggle.flat.secondary.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.theme.button.toggle.flat.secondary.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "hovered (active)" state

Normal foreground color

com.unblu.theme.button.toggle.flat.secondary.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "normal" state

Normal foreground color (active)

com.unblu.theme.button.toggle.flat.secondary.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "normal (active)" state

"Pressed" foreground color

com.unblu.theme.button.toggle.flat.secondary.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.theme.button.toggle.flat.secondary.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.flat.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "flat secondary toggle" button in "pressed (active)" state

Menu button style

"Hovered" background color

com.unblu.theme.button.menu.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "hovered" state

"Hovered" background color (active)

com.unblu.theme.button.menu.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "hovered (active)" state

Normal background color

com.unblu.theme.button.menu.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "normal" state

Normal background color (active)

com.unblu.theme.button.menu.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "normal (active)" state

"Pressed" background color

com.unblu.theme.button.menu.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "pressed" state

"Pressed" background color (active)

com.unblu.theme.button.menu.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "menu" button in "pressed (active)" state

"Hovered" border color

com.unblu.theme.button.menu.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "hovered" state

"Hovered" border color (active)

com.unblu.theme.button.menu.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "hovered (active)" state

Normal border color

com.unblu.theme.button.menu.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "normal" state

Normal border color (active)

com.unblu.theme.button.menu.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "normal (active)" state

"Pressed" border color

com.unblu.theme.button.menu.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "pressed" state

"Pressed" border color (active)

com.unblu.theme.button.menu.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.menu.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "menu" button in "pressed (active)" state

Border width

com.unblu.theme.button.menu.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "menu" button

"Hovered" foreground color

com.unblu.theme.button.menu.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "hovered" state

"Hovered" foreground color (active)

com.unblu.theme.button.menu.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "hovered (active)" state

Normal foreground color

com.unblu.theme.button.menu.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "normal" state

Normal foreground color (active)

com.unblu.theme.button.menu.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "normal (active)" state

"Pressed" foreground color

com.unblu.theme.button.menu.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "pressed" state

"Pressed" foreground color (active)

com.unblu.theme.button.menu.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "menu" button in "pressed (active)" state

Dropdown menu item style

"Hovered" background color

com.unblu.theme.menuitem.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "hovered" state

"Hovered" background color (active)

com.unblu.theme.menuitem.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "hovered (active)" state

Normal background color

com.unblu.theme.menuitem.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.backgroundLight\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "normal" state

Normal background color (active)

com.unblu.theme.menuitem.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "normal (active)" state

"Pressed" background color

com.unblu.theme.menuitem.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "pressed" state

"Pressed" background color (active)

com.unblu.theme.menuitem.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "dropdown menu" item in "pressed (active)" state

"Hovered" border color

com.unblu.theme.menuitem.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "hovered" state

"Hovered" border color (active)

com.unblu.theme.menuitem.borderHoverActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "hovered (active)" state

Normal border color

com.unblu.theme.menuitem.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "normal" state

Normal border color (active)

com.unblu.theme.menuitem.borderNormalActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "normal (active)" state

"Pressed" border color

com.unblu.theme.menuitem.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "pressed" state

"Pressed" border color (active)

com.unblu.theme.menuitem.borderPressActive

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "dropdown menu" item in "pressed (active)" state

Border width

com.unblu.theme.menuitem.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "dropdown menu" item

"Hovered" foreground color

com.unblu.theme.menuitem.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "hovered" state

"Hovered" foreground color (active)

com.unblu.theme.menuitem.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "hovered (active)" state

Normal foreground color

com.unblu.theme.menuitem.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "normal" state

Normal foreground color (active)

com.unblu.theme.menuitem.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "normal (active)" state

"Pressed" foreground color

com.unblu.theme.menuitem.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "pressed" state

"Pressed" foreground color (active)

com.unblu.theme.menuitem.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "dropdown menu" item in "pressed (active)" state

Primary button style

"Hovered" background color

com.unblu.theme.button.primary.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary600\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of primary buttons in "hovered" state

Normal background color

com.unblu.theme.button.primary.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary500\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of primary buttons in "normal" state

"Pressed" background color

com.unblu.theme.button.primary.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.primary700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of primary buttons in "pressed" state

"Hovered" border color

com.unblu.theme.button.primary.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of primary buttons in "hovered" state

Normal border color

com.unblu.theme.button.primary.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of primary buttons in "normal" state

"Pressed" border color

com.unblu.theme.button.primary.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of primary buttons in "pressed" state

Border width

com.unblu.theme.button.primary.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "primary" button

"Hovered" foreground color

com.unblu.theme.button.primary.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of primary buttons "hovered" state

Normal foreground color

com.unblu.theme.button.primary.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of primary buttons in "normal" state

"Pressed" foreground color

com.unblu.theme.button.primary.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of primary buttons "pressed" state

Secondary button style

"Hovered" background color

com.unblu.theme.button.secondary.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of secondary buttons in "hovered" state

Normal background color

com.unblu.theme.button.secondary.backgroundNormal

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of secondary buttons in "normal" state

"Pressed" background color

com.unblu.theme.button.secondary.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of secondary buttons in "pressed" state

"Hovered" border color

com.unblu.theme.button.secondary.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of secondary buttons in "hovered" state

Normal border color

com.unblu.theme.button.secondary.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of secondary buttons in "normal" state

"Pressed" border color

com.unblu.theme.button.secondary.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of secondary buttons in "pressed" state

Border width

com.unblu.theme.button.secondary.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of secondary buttons

"Hovered" foreground color

com.unblu.theme.button.secondary.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of secondary buttons in "hovered" state

Normal foreground color

com.unblu.theme.button.secondary.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of secondary buttons in "normal" state

"Pressed" foreground color

com.unblu.theme.button.secondary.foregroundPress

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.button.secondary.foregroundHover\},$lightness: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of secondary buttons in "pressed" state

SuccessButtonConfiguration

Hover border color

com.unblu.theme.button.success.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "success" button in "hovered" state

Normal border color

com.unblu.theme.button.success.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "success" button in "normal" state

Pressed border color

com.unblu.theme.button.success.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "success" button in "pressed" state

Border width

com.unblu.theme.button.success.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "success" button

Hover foreground color

com.unblu.theme.button.success.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "success" button in "hovered" state

Normal foreground color

com.unblu.theme.button.success.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "success" button in "normal" state

Press foreground color

com.unblu.theme.button.success.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "success" button in "pressed" state

Toggle button style

"Hovered" background color

com.unblu.theme.button.toggle.normal.backgroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "hovered" state

"Hovered" background color (active)

com.unblu.theme.button.toggle.normal.backgroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "hovered (active)" state

Normal background color

com.unblu.theme.button.toggle.normal.backgroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "normal" state

Normal background color (active)

com.unblu.theme.button.toggle.normal.backgroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary050\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "normal (active)" state

"Pressed" background color

com.unblu.theme.button.toggle.normal.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.backgroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "pressed" state

"Pressed" background color (active)

com.unblu.theme.button.toggle.normal.backgroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.secondary200\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of toggle buttons in "pressed (active)" state

"Hovered" border color

com.unblu.theme.button.toggle.normal.borderHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "hovered" state

"Hovered" border color (active)

com.unblu.theme.button.toggle.normal.borderHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.normal.borderHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "hovered (active)" state

Normal border color

com.unblu.theme.button.toggle.normal.borderNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "normal" state

Normal border color (active)

com.unblu.theme.button.toggle.normal.borderNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.normal.borderNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "normal (active)" state

"Pressed" border color

com.unblu.theme.button.toggle.normal.borderPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "pressed" state

"Pressed" border color (active)

com.unblu.theme.button.toggle.normal.borderPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.toggle.normal.borderPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of toggle buttons in "pressed (active)" state

Border width

com.unblu.theme.button.toggle.normal.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of toggle buttons

"Hovered" foreground color

com.unblu.theme.button.toggle.normal.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundHover\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "hovered" state

"Hovered" foreground color (active)

com.unblu.theme.button.toggle.normal.foregroundHoverActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "hovered (active)" state

Normal foreground color

com.unblu.theme.button.toggle.normal.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundNormal\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "normal" state

Normal foreground color (active)

com.unblu.theme.button.toggle.normal.foregroundNormalActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "normal (active)" state

"Pressed" foreground color

com.unblu.theme.button.toggle.normal.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.button.secondary.foregroundPress\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "pressed" state

"Pressed" foreground color (active)

com.unblu.theme.button.toggle.normal.foregroundPressActive

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of toggle buttons in "pressed (active)" state

ToggleSectionButtonConfiguration

Hover background color

com.unblu.theme.button.toggle.section.backgroundHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "toggle section" button in "hovered" state

Normal background color

com.unblu.theme.button.toggle.section.backgroundNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "toggle section" button in "normal" state

Press background color

com.unblu.theme.button.toggle.section.backgroundPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "toggle section" button in "pressed" state

Hover border color

com.unblu.theme.button.toggle.section.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "toggle section" button in "hovered" state

Normal border color

com.unblu.theme.button.toggle.section.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "toggle section" button in "normal" state

Press border color

com.unblu.theme.button.toggle.section.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "toggle section" button in "pressed" state

Border width

com.unblu.theme.button.toggle.section.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "toggle section" button

Hover foreground color

com.unblu.theme.button.toggle.section.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "toggle section" button in "hovered" state

Normal foreground color

com.unblu.theme.button.toggle.section.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLinkDark\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "toggle section" button in "normal" state

Press foreground color

com.unblu.theme.button.toggle.section.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "toggle section" button in "pressed" state

Font configuration

com.unblu.theme.font.colorLink

  • Type: Complex color

  • Default: #006CBD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for links in texts

Text color for clickable controls

com.unblu.theme.font.colorLinkDark

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for buttons and the like

"Announcement" text color

com.unblu.theme.font.colorTextAnnouncement

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightAnnouncement\}, $lightness: -50%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Light text color

com.unblu.theme.font.colorTextBody

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray700\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for text bodies and less prominent content

Dark text color

com.unblu.theme.font.colorTextDark

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray800\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for headings and subtitles

"Error" text color

com.unblu.theme.font.colorTextError

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightError\}, $lightness: -50%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Inverted text color

com.unblu.theme.font.colorTextInverted

  • Type: Complex color

  • Default: #ffffff

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used on dark backgrounds

Medium inverted text color

com.unblu.theme.font.colorTextInvertedMid

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.neutral100\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used on dark backgrounds for text bodies and less prominent content

Medium text color

com.unblu.theme.font.colorTextMid

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray600\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for labels and text highlights

"Action successful" text color

com.unblu.theme.font.colorTextSuccess

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightSuccess\}, $lightness: -50%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

"Warning" text color

com.unblu.theme.font.colorTextWarn

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.color.highlightWarning\}, $lightness: -50%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Fallback font families

com.unblu.theme.font.fontFamilyFallback

  • Type: List of strings

  • Default: Helvetica Neue,Helvetica,Arial,Lucida Grande,sans-serif

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used if a browser can’t load the main font

Normal font weight

com.unblu.theme.font.fontWeightNormal

  • Type: String with allowed values:

    • bold

    • bolder

    • lighter

    • normal

    • w100

    • w200

    • w300

    • w400

    • w500

    • w600

    • w700

    • w800

    • w900

  • Default: W400

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for all normal text

Semibold font weight

com.unblu.theme.font.fontWeightSemibold

  • Type: String with allowed values:

    • bold

    • bolder

    • lighter

    • normal

    • w100

    • w200

    • w300

    • w400

    • w500

    • w600

    • w700

    • w800

    • w900

  • Default: W500

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used for important text

H1 heading font size

com.unblu.theme.font.heading1Size

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

H2 heading font size

com.unblu.theme.font.heading2Size

  • Type: Integer

  • Default: 20

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

H3 heading font size

com.unblu.theme.font.heading3Size

  • Type: Integer

  • Default: 16

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Heading font color

com.unblu.theme.font.headingsFontColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Heading font weight

com.unblu.theme.font.headingsFontWeight

  • Type: String with allowed values:

    • normal

    • semibold

  • Default: SEMIBOLD

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Default line height factor

com.unblu.theme.font.lineHeight

  • Type: Float

  • Default: 1.4

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used for all text

Monospace font families

com.unblu.theme.font.monospaceFontFamily

  • Type: List of strings

  • Default: monospace,Courier New,Courier

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Paragraph font size

com.unblu.theme.font.paragraphSize

  • Type: Integer

  • Default: 14

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used for paragraphs, body text, and labels

Small text size

com.unblu.theme.font.textSmallSize

  • Type: Integer

  • Default: 12

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used for small, less prominent labels

Tiny font size

com.unblu.theme.font.textTinySize

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Used for tiny labels

LinkConfiguration

com.unblu.theme.link.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Font color used for links in hover state

com.unblu.theme.link.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorLink\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Font color used for links in normal state

com.unblu.theme.link.foregroundPress

  • Type: Complex color

  • Default: scale-color($\{com.unblu.theme.font.colorLink\}, $lightness: -25%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Font color used for links in pressed state

com.unblu.theme.link.underlineHover

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

If links should be underlined in hover state

com.unblu.theme.link.underlineNormal

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

If links should be underlined in normal state

com.unblu.theme.link.underlinePress

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

If links should be underlined in pressed state

ProgressiveWebAppConfiguration

Enable installing Unblu Agent Desk as a PWA

com.unblu.pwa.enableProgressiveWebApp

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If enabled, users can install the Unblu Agent Desk progressive web app (PWA) on their computer

Display mode of Agent Desk PWA

com.unblu.pwa.pwaDisplayMode

  • Type: String with allowed values:

    • browser

    • fullscreen

    • minimal_ui

    • standalone

  • Default: standalone

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Theme color of Agent Desk PWA

com.unblu.pwa.pwaThemeColor

  • Type: Simple color

  • Default: #404a80

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

LoggingConfiguration

configRestServiceEnabled

com.unblu.logging.configRestServiceEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable /unblu/rest/v1/loggingConfig?<logger1>=<level>&<logger2>=<level> for runtime configuration.

consoleJsonLogFormat

com.unblu.logging.consoleJsonLogFormat

  • Type: String

  • Default: \{"message": "%message %ex","logger": "%logger","severity": "%level","level": "%level","user": "%X{user}","client": "%X{client}","page": "%X{page}","request": "%X{request}","execution": "%X{execution}","thread": "%thread","@timestamp": "%date\{\"yyyy-MM-dd’T’HH:mm:ss.SSS\", UTC\}Z"\}

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Format of the console json log output

consoleLogEnabled

com.unblu.logging.consoleLogEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable log output to console.

consoleLogFormat

com.unblu.logging.consoleLogFormat

  • Type: String

  • Default: %-10(%d\{"yyyy-MM-dd’T’HH:mm:ss.SSSXXX", UTC\} %mdc\{X-Prefix:- \}[%20.20thread] [u:%X{user} s:%X{session} c:%X{client} p:%X{page} r:%X{request} e:%X{execution}] %-5level) \(%logger{5}\) %msg%n

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Format of the console log (defaults to mainLogFormat)

consoleUseJsonLogFormat

com.unblu.logging.consoleUseJsonLogFormat

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether we should output json or standard logs to console

customLogbackXml

com.unblu.logging.customLogbackXml

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Path to a custom logback xml configuration file. Caution: when using a custom logback xml, other com.unblu.logging configurations properties might not work as expected.

debug

com.unblu.logging.debug

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable debug output in the logging system

fatalLogEnabled

com.unblu.logging.fatalLogEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable a separate log file for fatal errors. Fatal errors are always alswo appended to the unblu log file

fatalLogFormat

com.unblu.logging.fatalLogFormat

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Format of the fatal log (defaults to mainLogFormat)

fatalLogMaxHistory

com.unblu.logging.fatalLogMaxHistory

  • Type: Integer

  • Default: -1

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Max number of files (days) of the fatal log that should be keept. Older logs will be deleted. -1 for keep all.

fileNameFormat

com.unblu.logging.fileNameFormat

  • Type: String

  • Default: <system>\{-<target>\}.<date>.log

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Logfile name format: must contain '<date> and '<target>' optinally may contain '<system>', <target> may be enclosed with curly brackets '\{\}' to add additional characters that are ommited if <target> is empty (such as the main log target)

mainLogFormat

com.unblu.logging.mainLogFormat

  • Type: String

  • Default: %-10(%d\{"yyyy-MM-dd’T’HH:mm:ss.SSSXXX", UTC\} [%20.20thread] [u:%X{user} s:%X{session} c:%X{client} p:%X{page} r:%X{request} e:%X{execution}] %-5level) %logger - %msg%n

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Format of the main log (also default for the fatal and console log)

mainLogMaxHistory

com.unblu.logging.mainLogMaxHistory

  • Type: Integer

  • Default: 7

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Max number of files (days) of the main log that should be keept. Older logs will be deleted. -1 for keep all.

outputDirectory

com.unblu.logging.outputDirectory

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

File system path (directory) where logfiles are written to.

rootLevel

com.unblu.logging.rootLevel

  • Type: String with allowed values:

    • all

    • debug

    • error

    • info

    • off

    • trace

    • warn

  • Default: INFO

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Default level for unblu.

rootLevelClient

com.unblu.logging.rootLevelClient

  • Type: String with allowed values:

    • all

    • debug

    • error

    • info

    • off

    • trace

    • warn

  • Default: WARN

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Level of the root logger for client logs

rootLevelThirdparty

com.unblu.logging.rootLevelThirdparty

  • Type: String with allowed values:

    • all

    • debug

    • error

    • info

    • off

    • trace

    • warn

  • Default: WARN

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Default level for main embedded third party components.

UnbluPlatform

httpWaitForReadyTimeoutSeconds

com.unblu.http.httpWaitForReadyTimeoutSeconds

  • Type: Integer

  • Default: 30

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

how many seconds http requests should be kept waiting for the platform to become ready until answering with a 503 status

Visitor authentication/user change management

Allow visitor login during session

com.unblu.authentication.allowVisitorLoginDuringSession

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Allow users with the role ANONYMOUS to log in while keeping the web session active. If not allowed, or if the user has a different role, the web session ends when the user changes.

AuthenticationConfigurationInternal

sources

com.unblu.authentication.internal.sources

  • Type: List of string with allowed values:s

    • local

    • none

    • propagated

  • Default: LOCAL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Sources of authentication for the INTERNAL entry path.

accountId

com.unblu.authentication.propagated.internal.accountId

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "accountId" field in the INTERNAL entry path

additionalInformation

com.unblu.authentication.propagated.internal.additionalInformation

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "additionalInformation" field in the INTERNAL entry path

allowBasicAuthentication

com.unblu.authentication.propagated.internal.allowBasicAuthentication

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether basic authentication is allowed for the INTERNAL entry path. Only relevant if the authentication source for the INTERNAL entry path is set to LOCAL.

allowUnbluTokenAuthentication

com.unblu.authentication.propagated.internal.allowUnbluTokenAuthentication

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether Unblu token authentication is allowed for the INTERNAL entry path. Only relevant if the authentication source for the INTERNAL entry path is set to LOCAL.

authInfo

com.unblu.authentication.propagated.internal.authInfo

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "authInfo" field in the INTERNAL entry path

email

com.unblu.authentication.propagated.internal.email

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "email" field in the INTERNAL entry path

firstName

com.unblu.authentication.propagated.internal.firstName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "firstName" field in the INTERNAL entry path

lastName

com.unblu.authentication.propagated.internal.lastName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "lastName" field in the INTERNAL entry path

phone

com.unblu.authentication.propagated.internal.phone

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "phone" field in the INTERNAL entry path

roles

com.unblu.authentication.propagated.internal.roles

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "roles" field in the INTERNAL entry path

teamId

com.unblu.authentication.propagated.internal.teamId

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "teamId" field in the INTERNAL entry path

URL decode header values

com.unblu.authentication.propagated.internal.urlDecodeHeaderValues

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether the propagated HTTP request header or cookie values should be URL decoded. If disabled, the propagated values must be within the ISO-8859-1 character set. If enabled, the propagated values must be URL encoded.

userId

com.unblu.authentication.propagated.internal.userId

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "userId" field in the INTERNAL entry path

Verify device cookie for Unblu token authentication

com.unblu.authentication.propagated.internal.verifyDeviceCookieForUnbluTokenAuthentication

Only visible if: com.unblu.authentication.propagated.internal.allowUnbluTokenAuthentication=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If set to 'true' (the default), only requests containing the expected device cookie are accepted. Disabling the device cookie check may be necessary if the device cookie is configured to be a session cookie, but it reduces the security of Unblu token authentication.

virtualUserMode

com.unblu.authentication.propagated.internal.virtualUserMode

  • Type: String with allowed values:

    • allow

    • always

    • deny

  • Default: DENY

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Virtual user mode in the INTERNAL entry path

AuthenticationConfigurationPublic

accountId

com.unblu.authentication.propagated.public.accountId

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "accountId" field in the PUBLIC entry path

additionalInformation

com.unblu.authentication.propagated.public.additionalInformation

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "additionalInformation" field in the PUBLIC entry path

allowBasicAuthentication

com.unblu.authentication.propagated.public.allowBasicAuthentication

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether basic authentication is allowed for the PUBLIC entry path. Only relevant if the authentication source for the PUBLIC entry path is set to LOCAL.

allowUnbluTokenAuthentication

com.unblu.authentication.propagated.public.allowUnbluTokenAuthentication

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether Unblu token authentication is allowed for the PUBLIC entry path. Only relevant if the authentication source for the PUBLIC entry path is set to LOCAL.

authInfo

com.unblu.authentication.propagated.public.authInfo

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "authInfo" field in the PUBLIC entry path

firstName

com.unblu.authentication.propagated.public.firstName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "firstName" in the PUBLIC entry path

lastName

com.unblu.authentication.propagated.public.lastName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "lastName" field in the PUBLIC entry path

URL decode header values

com.unblu.authentication.propagated.public.urlDecodeHeaderValues

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specifies whether the propagated HTTP request header or cookie values should be URL decoded. If disabled, the propagated values must be within the ISO-8859-1 character set. If enabled, the propagated values must be URL encoded.

userId

com.unblu.authentication.propagated.public.userId

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Propagation source for the "userId" field in the PUBLIC entry path

Verify device cookie for Unblu token authentication

com.unblu.authentication.propagated.public.verifyDeviceCookieForUnbluTokenAuthentication

Only visible if: com.unblu.authentication.propagated.public.allowUnbluTokenAuthentication=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If set to 'true' (the default), only requests containing the expected device cookie are accepted. Disabling the device cookie check may be necessary if the device cookie is configured to be a session cookie, but it reduces the security of Unblu token authentication.

sources

com.unblu.authentication.public.sources

  • Type: List of string with allowed values:s

    • local

    • none

    • propagated

  • Default: NONE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Sources of authentication for the PUBLIC entry path

ClaimMappingConfiguration

additionalInformation

com.unblu.authentication.tokenSignup.claimMapping.additionalInformation

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing additional information

authInfo

com.unblu.authentication.tokenSignup.claimMapping.authInfo

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing authentication information

email

com.unblu.authentication.tokenSignup.claimMapping.email

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing the email

firstName

com.unblu.authentication.tokenSignup.claimMapping.firstName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing the first name

lastName

com.unblu.authentication.tokenSignup.claimMapping.lastName

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing the last name

logoutToken

com.unblu.authentication.tokenSignup.claimMapping.logoutToken

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing the back-channel unique logout token for backend server logouts

username

com.unblu.authentication.tokenSignup.claimMapping.username

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JWT claim key containing the username

enabled

com.unblu.authentication.tokenSignup.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable login using a JWT

JwtConfiguration

JWT algorithm

com.unblu.authentication.jwt.algorithm

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If not specified, the algorithm is determined based on the keys retrieved from 'jwkUrl'.

Encryption key

com.unblu.authentication.jwt.encryptionKey

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The key must be an RSA private key in PEM format. It is used to decrypt JWTs.

Expected audience (optional)

com.unblu.authentication.jwt.expectedAudience

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Expected issuer

com.unblu.authentication.jwt.expectedIssuer

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Must be provided when JWT is used

HTTP header containing the token

com.unblu.authentication.jwt.httpHeader

  • Type: String

  • Default: x-goog-iap-jwt-assertion

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JSON Web Key (JWK) Url

com.unblu.authentication.jwt.jwkUrl

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The URL of the endpoint that provides the JSON Web Key (JWK) cryptographic keys to validate a JWT

Static JSON Web Key (JWK) Set

com.unblu.authentication.jwt.staticJwk

  • Type: Multiline string

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The static JSON Web Key (JWK) Set that contains the public key or keys to validate a JSON Web Token (JWT). The contents must conform to RFC7517 (https://www.rfc-editor.org/rfc/rfc7517#section-5).

TTL for token cache (in s)

com.unblu.authentication.jwt.tokenCacheTtl

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The value should be in the range of an acceptable clock skew, as the token isn’t revalidated during this period

Use encryption

com.unblu.authentication.jwt.useEncryption

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set to 'true' if JWTs are encrypted

JwtConfigurationInternal

JWT algorithm

com.unblu.authentication.jwt.internal.algorithm

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If not specified, the algorithm is determined based on the keys retrieved from 'jwkUrl'. Only used for INTERNAL entry paths.

Encryption key

com.unblu.authentication.jwt.internal.encryptionKey

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The key must be an RSA private key in PEM format. It is used to decrypt JWTs.

Expected audience (optional)

com.unblu.authentication.jwt.internal.expectedAudience

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Expected issuer

com.unblu.authentication.jwt.internal.expectedIssuer

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Must be provided when JWT is used

HTTP header containing the token

com.unblu.authentication.jwt.internal.httpHeader

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JSON Web Key (JWK) Url

com.unblu.authentication.jwt.internal.jwkUrl

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The URL of the endpoint that provides the JSON Web Key (JWK) cryptographic keys to validate a JWT. Only used for INTERNAL entry paths.

Static JSON Web Key (JWK) Set

com.unblu.authentication.jwt.internal.staticJwk

  • Type: Multiline string

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The static JSON Web Key (JWK) Set that contains the public key or keys to validate a JSON Web Token (JWT). The contents must conform to RFC7517 (https://www.rfc-editor.org/rfc/rfc7517#section-5). Only used for INTERNAL entry paths.

TTL for token cache (in s)

com.unblu.authentication.jwt.internal.tokenCacheTtl

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The value should be in the range of an acceptable clock skew, as the token isn’t revalidated during this period

Use encryption

com.unblu.authentication.jwt.internal.useEncryption

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set to 'true' if JWTs are encrypted

JwtConfigurationPublic

JWT algorithm

com.unblu.authentication.jwt.public.algorithm

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If not specified, the algorithm is determined based on the keys retrieved from 'jwkUrl'. Only used for PUBLIC entry paths.

Encryption key

com.unblu.authentication.jwt.public.encryptionKey

  • Type: Multiline secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The key must be an RSA private key in PEM format. It is used to decrypt JWTs.

Expected audience (optional)

com.unblu.authentication.jwt.public.expectedAudience

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Expected issuer

com.unblu.authentication.jwt.public.expectedIssuer

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Must be provided when JWT is used

HTTP header containing the token

com.unblu.authentication.jwt.public.httpHeader

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

JSON Web Key (JWK) Url

com.unblu.authentication.jwt.public.jwkUrl

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The URL of the endpoint that provides the JSON Web Key (JWK) cryptographic keys to validate a JWT. Only used for PUBLIC entry paths.

Static JSON Web Key (JWK) Set

com.unblu.authentication.jwt.public.staticJwk

  • Type: Multiline string

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The static JSON Web Key (JWK) Set that contains the public key or keys to validate a JSON Web Token (JWT). The contents must conform to RFC7517 (https://www.rfc-editor.org/rfc/rfc7517#section-5). Only used for PUBLIC entry paths.

TTL for token cache (in s)

com.unblu.authentication.jwt.public.tokenCacheTtl

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The value should be in the range of an acceptable clock skew, as the token isn’t revalidated during this period

Use encryption

com.unblu.authentication.jwt.public.useEncryption

  • Type: Boolean

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Set to 'true' if JWTs are encrypted

OidcConfiguration

tokenCacheTtl

com.unblu.authentication.oidc.tokenCacheTtl

  • Type: Integer

  • Default: 3600

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

TTL in seconds of the UserInfo endpoint response in the cache

userInfoEndpoint

com.unblu.authentication.oidc.userInfoEndpoint

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

URL of the UserInfo endpoint

OidcConfigurationInternal

tokenCacheTtl

com.unblu.authentication.oidc.internal.tokenCacheTtl

  • Type: Integer

  • Default: 3600

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

INTERNAL entry path specific TTL in seconds of the UserInfo endpoint response in the cache

userInfoEndpoint

com.unblu.authentication.oidc.internal.userInfoEndpoint

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

INTERNAL entry path specific URL of the UserInfo endpoint

OidcConfigurationPublic

tokenCacheTtl

com.unblu.authentication.oidc.public.tokenCacheTtl

  • Type: Integer

  • Default: 3600

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

PUBLIC entry path specific TTL in seconds of the UserInfo endpoint response in the cache

userInfoEndpoint

com.unblu.authentication.oidc.public.userInfoEndpoint

  • Type: URL

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

PUBLIC entry path specific URL of the UserInfo endpoint

AWSDefaultConfiguration

accessKey

com.unblu.management.aws.accessKey

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Your Amazon AWS access key

secretKey

com.unblu.management.aws.secretKey

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Your Amazon AWS secret access key

StaticPageConfiguration

colorBrandPrimary

com.unblu.staticpage.colorBrandPrimary

  • Type: String

  • Default: #fa6019

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Primary brand color used in static pages. Make sure this is in sync with com.unblu.ui.colorBrandPrimary

colorTextDark

com.unblu.staticpage.colorTextDark

  • Type: String

  • Default: #5c5f6a

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Primary text color used in static pages. Make sure this is in sync with com.unblu.ui.colorTextDark

VaultConfiguration

vaultAddress

com.unblu.vault.vaultAddress

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

URL of the Hashicorp Vault secrets engine. If not specified, the value of the VAULT_ADDR environment variable is used.

vaultAppRoleAuthenticationPath

com.unblu.vault.vaultAppRoleAuthenticationPath

  • Type: String

  • Default: approle

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The path to use for authentication in Hashicorp Vault with the AppRole authentication method

vaultAppRoleAuthenticationRoleId

com.unblu.vault.vaultAppRoleAuthenticationRoleId

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The role to use for authentication in Hashicorp Vault with the AppRole authentication method

vaultAppRoleAuthenticationSecretId

com.unblu.vault.vaultAppRoleAuthenticationSecretId

  • Type: Secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The secret ID to use for authentication in Hashicorp Vault with the AppRole authentication method

vaultAuthenticationLeaseTTLGracePeriodRatio

com.unblu.vault.vaultAuthenticationLeaseTTLGracePeriodRatio

  • Type: Float

  • Default: 0.8

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

After logging in to Hashicorp Vault, the Vault creates a lease with an expiry defined by the authentication role token TTL parameter. The lease is renewed at the expiry time multiplied by this value. For example, with a value of 0.8, the lease is renewed when 80% of its time-to-live (TTL) has passed.

vaultAuthenticationLeaseToRenewAutomatically

com.unblu.vault.vaultAuthenticationLeaseToRenewAutomatically

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

After logging in to Hashicorp Vault, the Vault creates a lease with an expiry defined by the authentication role token TTL parameter. The lease is renewed automatically if this configuration property is set to true.

vaultAuthenticationMethod

com.unblu.vault.vaultAuthenticationMethod

  • Type: String with allowed values:

    • approle

    • gcp_iam

    • kubernetes

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The authentication method for Hashicorp Vault

vaultDatabaseSecretsEngineAdminRole

com.unblu.vault.vaultDatabaseSecretsEngineAdminRole

  • Type: String

  • Default: unblu_admin

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The role in Hashicorp Vault to use for database access credentials when updating the database schema (Unblu admin user). If undefined, the non-admin role is used.

Vault database secrets engine role

com.unblu.vault.vaultDatabaseSecretsEngineRole

  • Type: String

  • Default: unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The role in Hashicorp Vault to use for loading regular database access credentials (Unblu user). Mandatory.

vaultGcpIamAuthenticationPath

com.unblu.vault.vaultGcpIamAuthenticationPath

  • Type: String

  • Default: gcp

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The path to use for authentication in Hashicorp Vault with the GCP IAM authentication method

vaultGcpIamAuthenticationRole

com.unblu.vault.vaultGcpIamAuthenticationRole

  • Type: String

  • Default: unblu-iam-role

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The role to use in Hashicorp Vault with the GCP IAM authentication method

vaultGcpIamAuthenticationServiceAccountKey

com.unblu.vault.vaultGcpIamAuthenticationServiceAccountKey

  • Type: Multiline secret

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

GCP service account key in JSON format. Used as the Google Cloud Service account key in Hashicorp Vault with the GCP IAM authentication method. If the value is not specified, we use Google’s Application Default Credentials method.

vaultKeyValueSecretsEngineEnabled

com.unblu.vault.vaultKeyValueSecretsEngineEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable the Hashicorp Vault key/value secrets engine for loading Unblu configuration properties

vaultKeyValueStorePath

com.unblu.vault.vaultKeyValueStorePath

  • Type: String

  • Default: secret/unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Hashicorp Vault key-value engine path dedicated to Unblu secrets.

vaultKubernetesAuthenticationPath

com.unblu.vault.vaultKubernetesAuthenticationPath

  • Type: String

  • Default: kubernetes

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The path to use for authentication in Hashicorp Vault with the Kubernetes authentication method

vaultKubernetesAuthenticationRole

com.unblu.vault.vaultKubernetesAuthenticationRole

  • Type: String

  • Default: unblu-role

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The role to use in Hashicorp Vault with the Kubernetes authentication method

vaultMaxRetries

com.unblu.vault.vaultMaxRetries

  • Type: Integer

  • Default: 1

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The maximum number of times that an API operation against Hashicorp Vault is retried upon failure

vaultPostgresDatabaseSecretsEngineCredentialsLeaseTTLGracePeriodRatio

com.unblu.vault.vaultPostgresDatabaseSecretsEngineCredentialsLeaseTTLGracePeriodRatio

  • Type: Float

  • Default: 0.8

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Hashicorp Vault credentials are rotated when the fraction of their remaining lease expiration is smaller than this value. For example, with a value of 0.8, the credentials are rotated when 80% of their time-to-live (TTL) has passed.

vaultPostgresDatabaseSecretsEngineEnabled

com.unblu.vault.vaultPostgresDatabaseSecretsEngineEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enable the Hashicorp Vault PostgreSQL database secrets engine for handling database access credentials

vaultRetryInterval

com.unblu.vault.vaultRetryInterval

  • Type: Integer

  • Default: 1000

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

The time (in milliseconds) that the driver waits between retry attempts for a failing API operation against Hashicorp Vault

Session

User change grace period

com.unblu.authentication.userChangeGracePeriodSeconds

  • Type: Integer

  • Default: 10

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

The grace period, in seconds, allowed during a user change. During the grace period, conflicting changes to users, e.g. switching between old and new users during ID propagation, are acceptable.

LocalizedTextConfiguration

textoverlay

com.unblu.textoverlay

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

the text overlay key or url to be used, comma separated list for multiple values

Static resource caching configuration

Server resources cache TTL

com.unblu.server.resources.cacheTime

  • Type: Integer

  • Default: -1

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: -1

Cache time to live (TTL), in seconds, for static resources. Set to -1 to cache resources forever.

enableDemoResources

com.unblu.server.resources.enableDemoResources

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Enable demo pages

enableDocResources

com.unblu.server.resources.enableDocResources

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Enable documentation pages

UnbluHttpServletResponseWrapperConfiguration

useErrorPageGenerator

com.unblu.http.useErrorPageGenerator

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not the error page generator should be enabled

UnbluRootServlet

healthCheckUserAgent

com.unblu.http.healthCheckUserAgent

  • Type: String

  • Default: GoogleHC

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

User Agent prefix of the health check requesting GET /, matching requests will not receive a redirect but a 200 OK

rootRedirect

com.unblu.http.rootRedirect

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

where requests to / should be redirected

XForwardedHeaderDelegate

enabled

com.unblu.http.xforwarded.enabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

If x-forwareded- header processing should be enabled

Authentication activator

Let root request pass

com.unblu.authentication.letRootRequestPass

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Requesting the root path '/' would usually apply PUBLIC entry path settings. This may prevent proper redirecting e.g. of the co-visitor. Set this property to 'true' to let the root request pass without check.

Unblu identifier configuration

Agent cookie max age

com.unblu.identifier.agentCookieMaxAge

  • Type: Integer

  • Default: 2147483647

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Max idle time for Agent Desk cookie (in s)

Name pattern for Agent Desk cookie

com.unblu.identifier.agentCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-agent

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Used to determine whether the user opening a public link is an agent

Max idle time for anonymous person cookie (in s)

com.unblu.identifier.anonymousPersonCookieMaxAge

  • Type: Integer

  • Default: 2147483647

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Name pattern for anonymous person cookie

com.unblu.identifier.anonymousPersonCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-anonymous-person

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Domain for cookies

com.unblu.identifier.cookieDomain

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

By default, cookies use FQDN, but in some situations, for example, site-embedded setups, it can be helpful to set a broader (second-level) domain for cookies

Set "HttpOnly" flag for cookies where possible

com.unblu.identifier.cookieHttpOnlyFlag

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Pattern for cookie prefixes

com.unblu.identifier.cookieNamePrefix

  • Type: String

  • Default: x-${systemIdentifier}$\{environmentQualifier;-$1\}

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

cookieSecureFlag

com.unblu.identifier.cookieSecureFlag

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Set "Secure" flag for cookies

Max idle time for device cookie (in s)

com.unblu.identifier.deviceCookieMaxAge

  • Type: Integer

  • Default: 2147483647

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Name pattern for device cookie

com.unblu.identifier.deviceCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-device

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Enforce source map reference

com.unblu.identifier.enforceSourceMapReference

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enforce appending source map URLs to JavaScript files. The default value is "false".

Environment qualifier

com.unblu.identifier.environmentQualifier

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The qualifier can be thought of as a name for an environment. For example, it’s added to cookie names as a prefix. A qualifier can be helpful when creating multiple Unblu environments on a shared (second-level) domain.

Pattern for INTERNAL path prefix (/app)

com.unblu.identifier.internalPathPrefix

  • Type: String

  • Default: app

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Base URL for internal (/app) access

com.unblu.identifier.internalServerBaseUrl

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

When not defined, the value of the configuration property 'com.unblu.identifier.publicServerBaseUrl' is used

Name pattern for language cookie

com.unblu.identifier.languageCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-lang

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Pattern for account-qualified session cookie names

com.unblu.identifier.multiAccountSessionCookieName

  • Type: String

  • Default: ${cookieNamePrefix}$\{apiKey;-$1\}-session

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Pattern for PUBLIC path prefix (/unblu)

com.unblu.identifier.publicPathPrefix

  • Type: String

  • Default: ${systemIdentifier}

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Server base URL

com.unblu.identifier.publicServerBaseUrl

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Add "SameSite" attribute on cookies

com.unblu.identifier.sameSiteCookieParamEnabled

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Value for "SameSite" attribute for internal path

com.unblu.identifier.sameSiteForInternalPath

  • Type: String with allowed values:

    • lax

    • none

    • strict

  • Default: Strict

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The value of the "SameSite" cookie attribute to for requests to the INTERNAL path in setups that aren’t site-embedded. The property must be set to NONE if the Agent Desk is integrated via an iframe.

Pattern for non account-qualified session cookie names

com.unblu.identifier.singleAccountSessionCookieName

  • Type: String

  • Default: ${cookieNamePrefix}-session

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Run Unblu in site-embedded setup

com.unblu.identifier.siteEmbeddedSetup

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

In a site-embedded setup, the Unblu origin is the same as the site origin

System identifier

com.unblu.identifier.systemIdentifier

  • Type: String

  • Default: unblu

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The default value is "unblu"

Pattern for SYSTEM path prefix (/system)

com.unblu.identifier.systemPathPrefix

  • Type: String

  • Default: system

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Domain for visitor client cookies

com.unblu.identifier.visitorClientCookieDomain

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Pattern for WEBHOOK path prefix (/webhook)

com.unblu.identifier.webhookPathPrefix

  • Type: String

  • Default: webhook

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

RestHelper

basicAuthEncoding

com.unblu.rest.basicAuthEncoding

  • Type: String with allowed values:

    • iso_8859_1

    • utf_8

  • Default: UTF_8

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Encoding scheme to use when decoding basic authentication credentials provided in the Authorization header field

error4xxcode

com.unblu.rest.error4xxcode

  • Type: Integer

  • Default: 0

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Which 4xx error code should be used for rest errors (effective status for rest errors will be 400 + value of this property)

SeoConfiguration

robots

com.unblu.seo.robots

  • Type: String

  • Default: User-agent: * Disallow: /

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Content of /robots.txt

AESEncryptUtil

encryptionKey

com.unblu.server.aes.encryptionKey

  • Type: Secret

  • Default: PAIKL9kMJsZaWUzXhzBzi6N2PUc2WduI33DVkIKbWc4=

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

The random secret to use for AES encryption. The secret must be either 16 or 32 bytes (128/256 bits) long and Base64 encoded.

Core server HTTP handling utility

Enable content encoding

com.unblu.server.enableContentEncoding

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to use content encoding

Redirect to HTTPS

com.unblu.server.redirectToHTTPS

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to redirect all traffic to HTTPS

UserIdentifierEncryption

enableEncryption

com.unblu.server.useridentifier.enableEncryption

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not user identifier encryption should be used.

Geolocation

Default time zone

com.unblu.platform.server.geolocation.defaultTimeZone

  • Type: String

  • Default: Europe/Zurich

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The default time-zone to be used if no time-zone can be determined from the visitor’s user agent. Refer to https://docs.oracle.com/javase/8/docs/api/java/time/ZoneId.html for more information. Three-letter IDs like CET (except UTC) are not supported.

Name pattern for cookie to override client location

com.unblu.platform.server.geolocation.locationOverrideCookieNameFormat

  • Type: String

  • Default: ${cookieNamePrefix}-geolocation

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Mail Service

Provider to send emails

com.unblu.mail.provider

  • Type: String with allowed values:

    • msoffice365

    • smtp

  • Default: SMTP

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Microsoft Office 365 account configuration

Application (client) ID

com.unblu.mail.msoffice365.account.clientId

Only visible if: com.unblu.mail.msoffice365.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Application (client) ID of the Azure App Registration used to send emails

Value of client credentials (client secret)

com.unblu.mail.msoffice365.account.clientSecret

Only visible if: com.unblu.mail.msoffice365.account.enabled=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Value of client credentials (client secret) created for the Azure App Registration used to send emails

Use account-specific MS Office 365 mail configuration

com.unblu.mail.msoffice365.account.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Email address of mailbox

com.unblu.mail.msoffice365.account.mailbox

Only visible if: com.unblu.mail.msoffice365.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Email address of the mailbox to send emails from

MS Office 365 proxy URL

com.unblu.mail.msoffice365.account.proxyUrl

Only visible if: com.unblu.mail.msoffice365.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Proxy URL used by the unblu server to access Microsoft Office 365. Supported format: http(s)://<host>:<port> (no authentication, no other protocols)

Directory (tenant) ID

com.unblu.mail.msoffice365.account.tenantId

Only visible if: com.unblu.mail.msoffice365.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Directory (tenant) ID of the Azure App Registration used to send emails

MSOffice365MailGlobalConfiguration

Application (client) ID

com.unblu.mail.msoffice365.global.clientId

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Application (client) ID of the Azure App Registration used to send emails

Value of client credentials (client secret)

com.unblu.mail.msoffice365.global.clientSecret

  • Type: Secret

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Value of client credentials (client secret) created for the Azure App Registration used to send emails

Email address of mailbox

com.unblu.mail.msoffice365.global.mailbox

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Email address of the mailbox to send emails from

MS Office 365 proxy URL

com.unblu.mail.msoffice365.global.proxyUrl

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Proxy URL used by the unblu server to access Microsoft Office 365. Supported format: http(s)://<host>:<port> (no authentication, no other protocols)

Directory (tenant) ID

com.unblu.mail.msoffice365.global.tenantId

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Directory (tenant) ID of the Azure App Registration used to send emails

SMTP account configuration

Use authentication

com.unblu.mail.smtp.account.auth

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If 'true', attempt to authenticate the user with the AUTH command

SMTP authentication type

com.unblu.mail.smtp.account.authType

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: String with allowed values:

    • basic

  • Default: BASIC

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If 'basic', use 'Basic Authentication' to log in (at the moment, this is the only supported authentication type)

Additional SMTP properties

com.unblu.mail.smtp.account.customProperties

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Additional SMTP properties not specified in other configuration properties. Enter the SMTP properties as a list of KEY=VALUE pairs. Consult the complete list at https://javaee.github.io/javamail/docs/api/.

Custom static headers

com.unblu.mail.smtp.account.customStaticHeaders

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Custom static headers for the mail client

Enable SMTP debug logging

com.unblu.mail.smtp.account.debug

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable debug logging of SMTP settings

Use account-specific SMTP configuration

com.unblu.mail.smtp.account.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Fallback sender address

com.unblu.mail.smtp.account.fromAddress

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The sender email address, unless defined elsewhere

SMTP server host name

com.unblu.mail.smtp.account.host

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The host name of the SMTP server to connect to

SMTP password

com.unblu.mail.smtp.account.pass

Only visible if: com.unblu.mail.smtp.account.auth=true

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Password for the SMTP server

SMTP server port

com.unblu.mail.smtp.account.port

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Integer

  • Default: 465

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The SMTP server port to connect to

SMTP server QUIT behavior

com.unblu.mail.smtp.account.quitwait

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

If 'true' (the default), the transport waits for the response to the QUIT command. If 'false', the connection is closed immediately after sending the QUIT command.

SMTP SSL socket factory class

com.unblu.mail.smtp.account.socketFactoryClass

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: String

  • Default: javax.net.ssl.SSLSocketFactory

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The name of a class that extends javax.net.ssl.SSLFactory. If specified, this class will be used to create SMTP SSL sockets.

Use SMTP SSL socket factory fallback

com.unblu.mail.smtp.account.socketFactoryFallback

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

SMTP SSL socket factory fallback: If set to true, failure to create a socket using the specified socket factory class will cause the socket to be created using the java.net.Socket class.

SMTP Socket factory port

com.unblu.mail.smtp.account.socketFactoryPort

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Integer

  • Default: 465

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The port to connect to when using the specified socket factory. If empty, the default port will be used.

Enable SMTP SSL

com.unblu.mail.smtp.account.sslEnable

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Use SSL to connect, and use the SSL port by default

Enable STARTTLS command

com.unblu.mail.smtp.account.startTlsEnable

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enable the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must be configured so that the client will trust the server’s certificate.

Enforce STARTTLS usage

com.unblu.mail.smtp.account.startTlsRequired

Only visible if: com.unblu.mail.smtp.account.startTlsEnable=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Enforce the use of the STARTTLS command. If the server doesn’t support STARTTLS, sending emails fails.

Content transfer encoding

com.unblu.mail.smtp.account.transferEncoding

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: String with allowed values:

    • base64

    • binary

    • quoted_printable

  • Default: QUOTED_PRINTABLE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

The content transfer encoding used for the MIME messages

Use raw encoding

com.unblu.mail.smtp.account.useRawEncoding

Only visible if: com.unblu.mail.smtp.account.enabled=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Specify whether to transmit 'text/html’message types with raw encoding. If set to 'true', no additional message encoding will be applied to the 'text/html' content type. If set to 'false', additional message encoding will be applied for the 'text/html' content type (apply HTML encoding). The default value is 'false'.

SMTP user name

com.unblu.mail.smtp.account.user

Only visible if: com.unblu.mail.smtp.account.auth=true

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

SmtpGlobalConfiguration

Use authentication

com.unblu.mail.smtp.global.auth

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

If 'true', attempt to authenticate the user with the AUTH command

SMTP authentication type

com.unblu.mail.smtp.global.authType

  • Type: String with allowed values:

    • basic

  • Default: BASIC

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

If 'basic', use 'Basic Authentication' to log in (at the moment, this is the only supported authentication type)

Additional SMTP properties

com.unblu.mail.smtp.global.customProperties

  • Type: List of strings

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Additional SMTP properties not specified in other configuration properties. Enter the SMTP properties as a list of KEY=VALUE pairs. Consult the complete list at https://javaee.github.io/javamail/docs/api/.

Custom static headers

com.unblu.mail.smtp.global.customStaticHeaders

  • Type: List of strings

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Custom static headers for the mail client

Enable SMTP debug logging

com.unblu.mail.smtp.global.debug

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Enable debug logging of SMTP settings

Fallback sender address

com.unblu.mail.smtp.global.fromAddress

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The sender email address, unless defined elsewhere

host

com.unblu.mail.smtp.global.host

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The host name of the SMTP server to connect to

pass

com.unblu.mail.smtp.global.pass

Only visible if: com.unblu.mail.smtp.global.auth=true

  • Type: Secret

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Password for the SMTP server

SMTP server port

com.unblu.mail.smtp.global.port

  • Type: Integer

  • Default: 465

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The SMTP server port to connect to

SMTP server QUIT behavior

com.unblu.mail.smtp.global.quitwait

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

If 'true' (the default), the transport waits for the response to the QUIT command. If 'false', the connection is closed immediately after sending the QUIT command.

SMTP SSL socket factory class

com.unblu.mail.smtp.global.socketFactoryClass

  • Type: String

  • Default: javax.net.ssl.SSLSocketFactory

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The name of a class that extends javax.net.ssl.SSLFactory. If specified, this class will be used to create SMTP SSL sockets.

Use SMTP SSL socket factory fallback

com.unblu.mail.smtp.global.socketFactoryFallback

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

SMTP SSL socket factory fallback: If set to true, failure to create a socket using the specified socket factory class will cause the socket to be created using the java.net.Socket class.

SMTP Socket factory port

com.unblu.mail.smtp.global.socketFactoryPort

  • Type: Integer

  • Default: 465

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The port to connect to when using the specified socket factory. If empty, the default port will be used.

Enable SMTP SSL

com.unblu.mail.smtp.global.sslEnable

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Use SSL to connect, and use the SSL port by default

Enable STARTTLS command

com.unblu.mail.smtp.global.startTlsEnable

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Enable the use of the STARTTLS command (if supported by the server) to switch the connection to a TLS-protected connection before issuing any login commands. Note that an appropriate trust store must be configured so that the client will trust the server’s certificate.

Enforce STARTTLS usage

com.unblu.mail.smtp.global.startTlsRequired

Only visible if: com.unblu.mail.smtp.global.startTlsEnable=true

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Enforce the use of the STARTTLS command. If the server doesn’t support STARTTLS, sending emails fails.

Content transfer encoding

com.unblu.mail.smtp.global.transferEncoding

  • Type: String with allowed values:

    • base64

    • binary

    • quoted_printable

  • Default: QUOTED_PRINTABLE

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

The content transfer encoding used for the MIME messages

Use raw encoding

com.unblu.mail.smtp.global.useRawEncoding

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Specify whether to transmit 'text/html’message types with raw encoding. If set to 'true', no additional message encoding will be applied to the 'text/html' content type. If set to 'false', additional message encoding will be applied for the 'text/html' content type (apply HTML encoding). The default value is 'false'.

user

com.unblu.mail.smtp.global.user

Only visible if: com.unblu.mail.smtp.global.auth=true

  • Type: String

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

SMTP user name

CORSConfiguration

corsCookieMode

com.unblu.server.cors.corsCookieMode

  • Type: String with allowed values:

    • local_domain_cookie

    • local_storage

    • product_domain

  • Default: PRODUCT_DOMAIN

  • Allowed scopes: GLOBAL

  • Visibility: PUBLIC

Browsers which are configured to prevent CORS cookies on an unvisited domain, can still be used by setting this to LOCAL_DOMAIN_COOKIE or LOCAL_STORAGE. This is only needed for CORS setups where unblu is not integrated in the main domain.

i18n configuration

Default country

com.unblu.text.defaultCountry

  • Type: String

  • Default: US

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

This setting is DEPRECATED. Use com.unblu.text.defaultLanguage to set a tag that complies with BCP 47 instead.

Default locale

com.unblu.text.defaultLanguage

  • Type: String

  • Default: en

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The locale must follow the BCP 47 language tag format. If the locale includes a region or country, the "defaultCountry" setting will not be used.

Fallback language

com.unblu.text.fallbackLanguage

  • Type: String

  • Default: en

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Used if a string isn’t available in the requested language

Enable 'fb' fallback language

com.unblu.text.fallbackLanguageEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The 'fb' language displays fallback text instead of translated text

Fallback locale evaluation order

com.unblu.text.fallbackPriorities

  • Type: String with allowed values:

    • langugage_first

    • region_first

  • Default: REGION_FIRST

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Assume a given zh-cmn-Hans-HK (Chinese mandarin simplified in Hongkong). With LANGUAGE_FIRST, the fallback chain is: zh-cmn-Hans-HK → zh-cmn-Hans → zh-Hans-HK → zh-Hans → zh-HK → zh. With REGION_FIRST, the fallback chain is: zh-cmn-Hans-HK → zh-Hans-HK → zh-HK → zh-cmn-Hans → zh-Hans → zh

Enable the 'key' language

com.unblu.text.keyLanguageEnabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The 'key' language displays i18n keys instead of translated texts

Supported Languages

com.unblu.text.supportedLanguages

  • Type: List of strings

  • Default: ar,cs,de,en,es,fr,it,pl,pt,ro,ru,sk,sl,sr,sv,th,zh-Hans,zh-Hant

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Using any other language results in a fallback to the default language

Use browser language

com.unblu.text.useBrowserLanguage

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Use language cookie

com.unblu.text.useLanguageCookie

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Specify whether to use a particular cookie to select the language

Use locale header

com.unblu.text.useLocaleHeader

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Specify whether to use a particular locale header to select the language

Languages with RTL text direction

com.unblu.text.useRtlDirection

  • Type: List of strings

  • Default: ar

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, APIKEY

  • Visibility: PUBLIC

List of supported languages written from right to left. Unblu displays texts for these languages in RTL direction.

i18n language names

CS

com.unblu.text.language.cs

  • Type: String

  • Default: čeština

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Czech language

DE

com.unblu.text.language.de

  • Type: String

  • Default: Deutsch

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the German language

EN

com.unblu.text.language.en

  • Type: String

  • Default: English

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the English language

ES

com.unblu.text.language.es

  • Type: String

  • Default: Español

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Spanish language

FR

com.unblu.text.language.fr

  • Type: String

  • Default: Français

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the French language

IT

com.unblu.text.language.it

  • Type: String

  • Default: Italiano

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Italian language

JA

com.unblu.text.language.ja

  • Type: String

  • Default: 日本語

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Japanese language

PL

com.unblu.text.language.pl

  • Type: String

  • Default: Polski

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Polish language

PT

com.unblu.text.language.pt

  • Type: String

  • Default: português

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Portuguese language

RU

com.unblu.text.language.ru

  • Type: String

  • Default: русский язык

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Russian language

SK

com.unblu.text.language.sk

  • Type: String

  • Default: Slovenčina

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Slovak language

SL

com.unblu.text.language.sl

  • Type: String

  • Default: Slovenščina

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Slovenian language

SR

com.unblu.text.language.sr

  • Type: String

  • Default: srpski

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Serbian language

ZH

com.unblu.text.language.zh

  • Type: String

  • Default: 中文

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Native name of the Chinese language

SystemEntryPathConfiguration

basicHTTPAuthenticationPassword

com.unblu.systementrypath.basicHTTPAuthenticationPassword

  • Type: Secret

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Basic Authentication Password for EEntryPath.SYSTEM servlet requests, used iff a user is supplied

basicHTTPAuthenticationUser

com.unblu.systementrypath.basicHTTPAuthenticationUser

  • Type: String

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Basic Authentication Username for EEntryPath.SYSTEM servlet requests, if not set, no authentication is used

enabled

com.unblu.systementrypath.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether EEntryPath.SYSTEM is available or not.

UnbluSharedPlatform

Allow usage of preview features

com.unblu.platform.enablePreview

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

WebhookEntryPathConfiguration

Whether EEntryPath.WEBHOOK is available or not

com.unblu.webhookentrypath.enabled

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Brand resources

Remove Unblu branding

com.unblu.ui.branding.disableUnbluBranding

  • Type: Boolean

  • Default: false

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Remove all "powered by Unblu" branding elements

externalBrandResourcesUrl

com.unblu.ui.branding.externalBrandResourcesUrl

  • Type: URL

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

URL to a non-encrypted zip file containing the following files: favicon.ico, logo.png, logo_inverse.png, logo_icon.png, logo_pwa_192.png, logo_pwa_512.png, logo_pwa_vector.svg. Unblu defaults are used for any missing files.

Default web font

com.unblu.ui.branding.fontFamilyWebfont

  • Type: String

  • Default: Rubik

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

The name of the default web font to be used for the user interface. The font should either be present on the client, or a CSS URL must be defined to load the font.

URL for custom web font CSS

com.unblu.ui.branding.fontFamilyWebfontCssUrl

  • Type: String

  • Default: unblu://com.unblu.platform.shared.core/font/rubik/modern/style.min.css

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

URL for the custom web font CSS file. The referenced CSS file should load the web font specified in the 'FontFamilyWebfont' setting. The URL must either be an absolute http(s):// URL or an unblu://[bundleName]/[resourcePath] URL if the CSS file is provided internally. Leave the setting empty if the font is already on the client, e.g. because it is on the website that Unblu is embedded in.

Content Security Policy (CSP) configuration

CSP application mode

com.unblu.contentsecuritypolicy.mode

  • Type: String with allowed values:

    • off

    • on

    • report_only

  • Default: OFF

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

How to apply the Content Security Policy (CSP). Select OFF to not enforce the CSP, REPORT_ONLY to only report CSP violations, or ON to enforcing the CSP.

LocationStrategyConfiguration

agentWebLocationStrategy

com.unblu.entrypoint.locationstrategy.agentWebLocationStrategy

  • Type: String with allowed values:

    • hash

    • path

  • Default: HASH

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Location strategy used for the Agent Desk and Single Conversation Desk. Be aware that changing the location strategy breaks all previously saved URLs, for example in bookmarks. All URLs returned by the web API are affected by this configuration property.

configLocationStrategy

com.unblu.entrypoint.locationstrategy.configLocationStrategy

  • Type: String with allowed values:

    • hash

    • path

  • Default: HASH

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Location strategy used for the Account Configuration and Global Server Configuration interfaces. Be aware that changing the location strategy breaks all previously saved URLs, for example in bookmarks). All URLs returned by the web API are affected by this configuration property.

recordingLocationStrategy

com.unblu.entrypoint.locationstrategy.recordingLocationStrategy

  • Type: String with allowed values:

    • hash

    • path

  • Default: HASH

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Location strategy used for the Recording and Audio Recording entry points. Be aware that changing the location strategy breaks all previously saved URLs, for example in bookmarks. All URLs returned by the web API are affected by this configuration property.

Redirect target validation

Redirect target black list

com.unblu.redirectFilter.black

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List of patterns for redirect targets not allowed, i.e. black list

Order redirect target validation

com.unblu.redirectFilter.order

  • Type: String with allowed values:

    • black_white

    • white_black

  • Default: BLACK_WHITE

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Order of the redirect target validation black/white list pattern list

Whitelist

com.unblu.redirectFilter.white

  • Type: List of strings

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

List of patterns for redirect targets allowed, i.e. white list

Shared color configuration

Colors for secondary elements

com.unblu.theme.color.secondaryColorMap

  • Type: List of simple colors

  • Default: ["#c01160","#a63284","#9751b9","#5167b9","#16808b","#2b8539","#946e00","#ba4f25","#8b533d","#766554"]

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Colors used for secondary elements such as avatars. Text on them is displayed in white.

ProxyConfigurationProperties

acceptSelfSignedSSL

com.unblu.proxy.acceptSelfSignedSSL

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not invalid SSL certificates should be silently accepted

additionalExternalCSS

com.unblu.proxy.additionalExternalCSS

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

URI to an additional external CSS that will be injected in HTML responses

additionalExternalJavascript

com.unblu.proxy.additionalExternalJavascript

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

URI to an additional external javascript that will be injected in HTML responses

backendBaseUrl

com.unblu.proxy.backendBaseUrl

  • Type: String

  • Default: universal

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Backend base url of the proxy (fully qualified url or one of universal, forward, disabled or wildcard)

forwardCookies

com.unblu.proxy.forwardCookies

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not cookies should be forwarded

forwardReferer

com.unblu.proxy.forwardReferer

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not the referer header should be forwarded

preventCaching

com.unblu.proxy.preventCaching

  • Type: Boolean

  • Default: false

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not cache preventing headers should be added to all responses

promoteSecureCookies

com.unblu.proxy.promoteSecureCookies

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not secure cookies should be promoted

rewriteBaseTag

com.unblu.proxy.rewriteBaseTag

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not the base tag should be rewritten

rewriteCss

com.unblu.proxy.rewriteCss

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not CSS should be rewritten

rewriteHtml

com.unblu.proxy.rewriteHtml

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not HTML should be rewritten

rewriteMeta

com.unblu.proxy.rewriteMeta

  • Type: Boolean

  • Default: true

  • Allowed scopes: GLOBAL, ACCOUNT

  • Visibility: PUBLIC

Whether or not meta tags should be rewritten

rootRedirect

com.unblu.proxy.rootRedirect

  • Type: String

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Where to redirect requests with path /

showErrorInformation

com.unblu.proxy.showErrorInformation

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not information about the error should be shown in the error page

translateCookiePath

com.unblu.proxy.translateCookiePath

  • Type: Boolean

  • Default: true

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Whether or not cookie paths should be translated

urltranslationStrategy

com.unblu.proxy.urltranslationStrategy

  • Type: String

  • Default: ABSOLUTE_PATH

  • Allowed scopes: IMMUTABLE

  • Visibility: PUBLIC

Strategy for rewriting urls (ABSOLUTE_PATH, ABSOLUTE_URL, AS_BACKEND)

Screen sharing UI

Media track maximum frame rate

com.unblu.conversation.collabspace.screensharing.mediaConstraintMaxFrameRate

  • Type: Float

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 1

Maximum frame rate, in frames per second, of the video stream (for example, 15.0fps)

Media track maximum height

com.unblu.conversation.collabspace.screensharing.mediaConstraintMaxHeight

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum height, in pixels, of the video stream (for example, 1024px)

Media track maximum width

com.unblu.conversation.collabspace.screensharing.mediaConstraintMaxWidth

  • Type: Integer

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Maximum width, in pixels, of the video stream (for example, 1280p)

Media track resize mode

com.unblu.conversation.collabspace.screensharing.mediaConstraintResizeMode

  • Type: String with allowed values:

    • crop_and_scale

    • none

  • Default: NONE

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Specifies the mode the browser can use to derive the resolution of a video track. "NONE" means that the browser uses the resolution provided by the camera, its driver or the OS. "CROP_AND_SCALE" means that the browser can use cropping and downscaling on the camera output in order to satisfy other constraints that affect the resolution.

Background color of "recorder" title bar

com.unblu.conversation.collabspace.screensharing.recorderTitleBarBackgroundColor

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray100\}

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The title bar is displayed in screen sharing collaboration layers

Foreground color of screen sharing title bar

com.unblu.conversation.collabspace.screensharing.recorderTitleBarForegroundColor

  • Type: String with allowed values:

    • announcement

    • body

    • dark

    • error

    • inverted

    • inverted_mid

    • link

    • link_dark

    • mid

    • success

    • warn

  • Default: BODY

  • Allowed scopes: GLOBAL, ACCOUNT, TEAM, USER

  • Visibility: PUBLIC

The title bar is displayed in screen sharing collaboration layers

UnmuteVideoButtonConfiguration

Hover background color

com.unblu.conversation.collabspace.screensharing.unmuteButton.backgroundHover

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -10%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "screen sharing unmute" button in "hovered" state

Normal background color

com.unblu.conversation.collabspace.screensharing.unmuteButton.backgroundNormal

  • Type: Complex color

  • Default: adjust-color($\{com.unblu.theme.color.gray900\},$alpha: -20%)

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "screen sharing unmute" button in "normal" state

Press background color

com.unblu.conversation.collabspace.screensharing.unmuteButton.backgroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.color.gray900\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the background of the "screen sharing unmute" button in "pressed" state

Hover border color

com.unblu.conversation.collabspace.screensharing.unmuteButton.borderHover

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "screen sharing unmute" button in "hovered" state

Normal border color

com.unblu.conversation.collabspace.screensharing.unmuteButton.borderNormal

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "screen sharing unmute" button in "normal" state

Press border color

com.unblu.conversation.collabspace.screensharing.unmuteButton.borderPress

  • Type: Complex color

  • Default: transparent

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the border of the "screen sharing unmute" button in "pressed" state

Border radius

com.unblu.conversation.collabspace.screensharing.unmuteButton.borderRadius

  • Type: Integer

  • Default: 24

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border radius of the "screen sharing unmute" button

Border width

com.unblu.conversation.collabspace.screensharing.unmuteButton.borderWidth

  • Type: Integer

  • Default: 1

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

  • Constraints:

    • Minimum value: 0

Border width of the "screen sharing unmute" button

Hover foreground color

com.unblu.conversation.collabspace.screensharing.unmuteButton.foregroundHover

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "screen sharing unmute" button in "hovered" state

Normal foreground color

com.unblu.conversation.collabspace.screensharing.unmuteButton.foregroundNormal

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "screen sharing unmute" button in "normal" state

Press foreground color

com.unblu.conversation.collabspace.screensharing.unmuteButton.foregroundPress

  • Type: Complex color

  • Default: $\{com.unblu.theme.font.colorTextInverted\}

  • Allowed scopes: GLOBAL, ACCOUNT, AREA, TEAM, USER, APIKEY

  • Visibility: PUBLIC

Color used for the foreground of the "screen sharing unmute" button in "pressed" state