Boot Option

An object that contains information for ChannelIO boot

pluginKey require

typedescription
stringChannel plugin's key

memberId optional

typedescription
stringmember (user) identification id used by your company

❗️

Do not recommend to use a predictable value for memberId

Because memberId is a unique value that we use to identify users, we do not recommend to use predictable values such as numerical combination, email address, user name and etc. It may cause privacy and security issues. We recommend to use higher than 256 bits hash value.

customLauncherSelector optional

typedescription
stringCss selector for custom button. Use it with hideChannelButtonOnBoot set to true

hideChannelButtonOnBoot optional

🚧

hideDefaultLauncher will be supported until 2022. After that time it will be deprecated.

NOTE: Recommend to use hideChannelButtonOnBoot instead.

typedescription
booleanFlag to decide whether to hide the default button.

zIndex optional

typedescription
integerCustom plugin button's z-index

language optional

🚧

locale will be supported until 2022. After that time it will be deprecated.

NOTE: Recommend to use language instead.

typedescription
stringSet default language. Only (en, ko, ja) available. It does not change for users who have already been created.

trackDefaultEvent optional

🚧

enabledTrackDefaultEvent will be supported until 2022. After that time it will be deprecated.

NOTE: Recommend to use trackDefaultEvent instead.

typedescription
booleanWhether to send default events (usually PageView). Default value is true

trackUtmSource optional

🚧

enabledUtmSourceTrack will be supported until 2022. After that time it will be deprecated.

NOTE: Recommend to use trackUtmSource instead.

typedescription
booleanFlag to decide whether to track UTM source and referrer or not. Default value is true

profile optional

typedescription
objectProfile object contains user information. If this property is present, it will be used when boot is get called

mobileMessengerMode optional

🚧

mobileOpenUI will be supported until 2022. After that time it will be deprecated.

NOTE: Recommend to use mobileMessengerMode instead.

🚧

NOTE

Do not recommend use "iframe" option

typedescription
stringSet chat ux. Only (newTab, iframe) available.

default is "newTab"

unsubscribed optional

typedescription
booleana value of whether or not to accept marketing

memberHash optional

typedescription
stringthe hashed value of memberId using SHA256

hidePopup optional

typedescription
booleanSet whether to hide marketing and message notification pop-up

Example:

var settings = {
    "pluginKey": "YOUR_PLUGIN_KEY",
    "memberId": "YOUR_USER_ID",
    "customLauncherSelector": ".custom-button-1, #custom-button-2",
    "hideChannelButtonOnBoot": true,
    "trackDefaultEvent": false,
    "trackUtmSource": false,
    "openChatDirectlyAsPossible": true,
    "mobileMessengerMode": "newTab",
    "zIndex": 1,
    "language": "en",
    "profile": {
      "name": "YOUR_USER_NAME",
      "mobileNumber": "YOUR_USER_MOBILE_NUMBER",
      "email": "[email protected]",
      "avatarUrl": "http://IMAGE_URL",
      "CUSTOM_VALUE_1": "VALUE_1",
      "CUSTOM_VALUE_2": "VALUE_2"
    },
    "unsubscribed": false,
    "memberHash": <generted_hash>,
    "hidePopup": false,
};

ChannelIO('boot', settings);