Boot Option

This document explains boot options as the parameter of the boot.
See the example in Quick Start.

Required options

pluginKey

typedescription
stringThe plugin key of your channel.

Optional options

memberId

typedescription
stringThe id of member user.

customLauncherSelector

typedescription
stringThe CSS Selector to select custom launcher.
Use when you customize default chat button.

hideChannelButtonOnBoot

typedescription
booleanSet whether to hide the default chat button.
The default value is false.

zIndex

typedescription
numberSet the z-index of the elements made by the SDK.
Applied at chat button, messenger, and marketing pop-up.
The default value is 10000000.

language

typedescription
string
(‘en’ | ‘ko’ | ’ja’)
Set the default value of the language.
Texts differ based on the language. When a user is created newly, the user’s language is set as the language. language doesn’t change the user’s language already created.

trackDefaultEvent

typedescription
booleanSet whether to track the default event(PageView) or not.
The default value is true.

trackUtmSource

typedescription
booleanSet whether to track the UTM source and referrer or not.
The default value is true.

profile

typedescription
objectSet the user’s profile.

mobileMessengerMode

🚧

We recommend using the default value, "newTab" option.

The "newTab" option provides an optimized UI for a smooth chat experience.

typedescription
string
("newTab" | "iframe")
Set the way a chat is opened.
When "newTab", a chat is opened in a new tab. When "iframe", a chat is opened in the iframe in the same tab.
The default value is "newTab".

unsubscribe

🚧

unsubscribe will be deprecated after 2023.

Use the unsubscribeEmail and unsubscribeTexting instead.

typedescription
booleanSet whether to unsubscribe marketing email and SMS for the user.
The default value is false.

unsubscribeEmail

typedescription
booleanSet whether to unsubscribe marketing email for the user.
The default value is false.

unsubscribeTexting

typedescription
booleanSet whether to unsubscribe marketing email for the user.
The default value is false.

memberHash

typedescription
stringSet the hashed value of the memberId using HMAC-SHA256.

hidePopup

typedescription
booleanSet whether to hide the marketing pop-ups and the message alarm pop-ups.
The default value is false.

appearance

typedescription
string
("light" | "dark" | "system" | null)
Set the initial appearance of the theme.
The default value is null.
  • "light": Use the light theme.
  • "dark": Use the dark theme.
  • "system": Follow the system theme.
  • null: Follow the desk’s theme setting.