Boot Option

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

Required options

pluginKey

type	description
`string`	Your channel's plugin key.

Optional options

memberId

type	description
`string`	The ID of the member user.

customLauncherSelector

type	description
`string`	The CSS Selector to select a custom launcher. Use this option to customize the default chat button.

hideChannelButtonOnBoot

type	description
`boolean`	Determines whether to hide the default chat button on boot. The default value is `false`.

zIndex

type	description
`number`	Sets the z-index for SDK elements, such as the chat button, messenger, and marketing pop-ups. The default value is `10000000`.

language

type	description
`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

type	description
`boolean`	Determines whether to track the default event(PageView). The default value is `true`.

trackUtmSource

type	description
`boolean`	Determines whether to track the UTM source and referrer. The default value is true.

profile

type	description
`object`	Sets the user’s profile.

unsubscribe

🚧
unsubscribe will be deprecated after 2023.
Use unsubscribeEmail and unsubscribeTexting instead.

type	description
`boolean`	Set whether to unsubscribe marketing emails and SMS for the user. The default value is `false`.

unsubscribeEmail

type	description
`boolean`	Set whether to unsubscribe marketing emails for the user. The default value is `false`.

unsubscribeTexting

type	description
`boolean`	Set whether to unsubscribe marketing SMS for the user. The default value is `false`.

memberHash

type	description
`string`	Set the hashed value of the memberId using HMAC-SHA256.

hidePopup

type	description
`boolean`	Determines whether to hide marketing and message alarm pop-ups. The default value is `false`.

appearance

type	description
`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.

Updated 12 months ago