Configuration

The only required option; your organization’s widget token. you can find it in Dashboard / Widget.

The language of the widget’s interface.

Available options: en, fr, nl, de, pt, ar

Initial messages that the user sees in a new chat session. These messages will disappear once the user sends their first message.

If turned on, the widget will have a login-like screen to collect user’s name and email. A non-verified contact will be created based on the provided information.

Extra data collection fields besides name and email. For this setting to take effect, collectUserData must be set to true.

Provide initial values for the name and email inputs in the welcome screen. For this setting to take effect, collectUserData must be set to true.

Name and avatar of the bot.

Verified or non-verified contact data. If no data is provided, an anonymous contact will be created.

For more details and recipes, check the Authentication page.

{
  "org_id": "org_185938572649",
  "vip": true,
  "loyalty_points": 1200
}

Custom text content to override the defaults in the widget.

Theme customization options.

Customize routing rules between screens.

The target attribute for all links in the AI or human agents responses. Available options: _top, _blank

• _top opens links in the same tab.
• _blank opens links in a new tab or window.

Custom headers to be sent with each AI action called.

{
  "auth_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VyX2lkIjoxMjN9.KwXvsvfT7Z67fdDb8JqB_34e7FekbF3PZjM4CrcK8dE",
}

Custom query params to be sent with each AI action called.

{
  "session_id": "9de647ba-25b9-4d9e-b51a-7ab2f4c68d9d",
}

Dynamic context to be sent with each send-message request from the widget.

{
  "page": {
    "url": window.location.href
  },
  "product_id": "99836009",
  "product_name": "Ineffective painkiller",
  "product_price": 12.99,
}