Boot Option

This document explains the boot options as parameters for boot.
For usage examples, refer to Quick Start.

Required options

pluginKey

typedescription
stringYour channel's plugin key.

Optional options

memberId

typedescription
stringThe ID of the member user.

customLauncherSelector

typedescription
stringThe CSS Selector to select a custom launcher.
Use this option to customize the default chat button.

hideChannelButtonOnBoot

typedescription
booleanDetermines whether to hide the default chat button on boot.
The default value is false.

zIndex

typedescription
numberSets the z-index for SDK elements, such as the chat button, messenger, and marketing pop-ups.
The default value is 10000000.

language

typedescription
string
(‘en’ | ‘ko’ | ’ja’)
Sets the default language.
This affects text display and sets the language for new users. Existing user language settings will not change.

trackDefaultEvent

typedescription
booleanDetermines whether to track the default event(PageView).
The default value is true.

trackUtmSource

typedescription
booleanDetermines whether to track the UTM source and referrer.
The default value is true.

profile

typedescription
objectSets the user’s profile.

unsubscribe

🚧

unsubscribe will be deprecated after 2023.

Use unsubscribeEmail and unsubscribeTexting instead.

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

unsubscribeEmail

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

unsubscribeTexting

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

memberHash

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

hidePopup

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

appearance

typedescription
string
("light" | "dark" | "system" | null)
Set the initial theme appearance.
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.