Skip to main content

Website channel settings

website_urlstring

URL at which the widget will be loaded

Example: https://example.com
welcome_titlestring

Welcome title to be displayed on the widget

Example: Welcome to our support
welcome_taglinestring

Welcome tagline to be displayed on the widget

Example: We are here to help you
widget_colorstring

A Hex-color string used to customize the widget

Example: #FF5733
reply_timestring

Expected reply time shown on the widget

Possible values: [in_a_few_minutes, in_a_few_hours, in_a_day]

Example: in_a_few_minutes
pre_chat_form_enabledboolean

Enable the pre-chat form before starting a conversation

Example: false
pre_chat_form_optionsobject

Pre-chat form configuration

Example: {"pre_chat_message":"Share your queries or comments here.","pre_chat_fields":[{"field_type":"standard","label":"Email Id","name":"emailAddress","type":"email","required":true,"enabled":true}]}
continuity_via_emailboolean

Continue conversations over email when the contact leaves the website

Example: true
hmac_mandatoryboolean

Require HMAC verification for contacts using the widget

Example: false
allowed_domainsstring

Comma-separated list of domains where the widget is allowed to load

Example: example.com
selected_feature_flagsstring[]

Enabled widget feature flags

Possible values: [attachments, emoji_picker, end_conversation, use_inbox_avatar_for_bot, allow_mobile_webview]

Example: ["attachments","emoji_picker","end_conversation"]
Website channel settings
{
"website_url": "https://example.com",
"welcome_title": "Welcome to our support",
"welcome_tagline": "We are here to help you",
"widget_color": "#FF5733",
"reply_time": "in_a_few_minutes",
"pre_chat_form_enabled": false,
"pre_chat_form_options": {
"pre_chat_message": "Share your queries or comments here.",
"pre_chat_fields": [
{
"field_type": "standard",
"label": "Email Id",
"name": "emailAddress",
"type": "email",
"required": true,
"enabled": true
}
]
},
"continuity_via_email": true,
"hmac_mandatory": false,
"allowed_domains": "example.com",
"selected_feature_flags": [
"attachments",
"emoji_picker",
"end_conversation"
]
}