Kindly Chat is a feature rich and customizable chat client for the web. New versions packing features and updates are made available continously. You can read more on supported versions below.

Get the HTML snippet

Start by navigating to your bot in the Kindly platform.

Select Connect from the left-hand menu, then click Kindly Chat - Publish your chatbot.

Under the heading Get HTML code go ahead and copy it by hitting Copy to clipboard. You'll need this code to embed Kindly Chat on your site.

The HTML snippet should look something like this:

<script
    id="kindly-chat"
    src="https://chat.kindlycdn.com/kindly-chat.js"
    data-bot-key="YOUR-BOT-KEY"
    data-shadow-dom="1"
    async
></script>

A pure build is also available.

Deploying Kindly Chat

Once you have copied the snippet, you're ready to add Kindly Chat to your site. This should be a simple process that involves updating an HTML template. Put the snippet in your HTML template, before the closing </body> tag.

If this sounds strange, foreign or scary, we recommend you contact your website administrator or a developer in your organization for further assistance.

Using Google Tag Manager?

When using Google Tag Manager (GTM), the script needs to be added programmatically. This means the HTML snippet won't work, as GTM won't be able to load its attributes like data-bot-key. When adding a new tag, choose the "custom HTML" option and paste the following snippet into the editor:

<script>
    var script = document.createElement("script");
    script.src = "https://chat.kindlycdn.com/kindly-chat.js";
    script.async = true;
    script.id = "kindly-chat";
    script.setAttribute("data-shadow-dom", "1");
    script.setAttribute("data-bot-key", "YOUR-BOT-KEY");
    document.body.appendChild(script);
</script>

One thing worth noting when implementing with GTM, is that the chat bubble can be hidden for some users using an ad blocker extension. Therefore we do recommend implementing the chat bubble directly into the source code, or via a CMS if possible.

Customizing

There are two options available for configuring Kindly Chat appearance and behaviour:

• Set default settings directly through the Kindly platform.

• Override the default settings using options in your site HTML (window.kindlyOptions). This allows for per page customization. See the section options reference for a list of supported options.

Set default behaviour and appearance

Start by navigating to your bot in the Kindly platform.

From the left-hand menu, open Settings, then go to Kindly Chat.

Configure the bot behaviour and appearance according to your needs.

Override behaviour or appearance per page

Sometimes Kindly Chat needs slightly different behaviour or appearance depending on the page the user is visiting. This can be accomplished by adding options to the original HTML snippet. Use the following HTML snippet for overriding the settings. Remember to replace the part that says 'YOUR-BOT-KEY' with the value from your original HTML snippet.

NOTE: In this example, available options have been commented out. To activate an option, uncomment the line by removing "//" from the start of the line.

<script>
    window.kindlyOptions = {
        // chatbubble: {
        //   autopopup: false,
        //   autopopup_time: 10000, // ms
        // },
        // name: 'Your bot name',
        // bubbleHidden: true,
        // context: { /* your own context */ },
        // getAuthToken: async function(chatId) { /* return token code */ },
    };
</script>
<script
    id="kindly-chat"
    src="https://chat.kindlycdn.com/kindly-chat.js"
    data-bot-key="YOUR-BOT-KEY"
    async
></script>

Set initial language

If you need to pre-configure which language the bot should use to greet the user, just set window.kindlyOptions.language to a valid language code. See example below.

<script>
    window.kindlyOptions = {
        language: "nb",
    };
</script>
<script
    id="kindly-chat"
    src="https://chat.kindlycdn.com/kindly-chat.js"
    data-bot-key="YOUR-BOT-KEY"
    async
></script>

Valid language codes

Currently we support the following language codes: da, en, fi, nb, nn and sv.

Options reference

Options are passed in with data attributes on the <script> tag or the global window.kindlyOptions.

Property reference

Callback reference

Nudge callbacks

Callback used along with nudges. Read more about them here.​

Function reference

Available methods on window.kindlyChat

Nudge functions

The following functions are usable independant of the nudge type you want to use them with. Read more about nudges here.

Authentication

Kindly supports authenticating your users. When your users are authenticated, it's easier to identify them in the Kindly Inbox and you can create more personalized and powerful webhook integrations.

To set this up you need to do a few things:

• Add a callback to Kindly Chat initialization code.

• Create a private/public key pair.

• Create an authentication endpoint that returns a JWT in a specific format.

After the inital implementation and setup you are able to:

• See user details in the Kindly Inbox.

• Identify users in webhooks (via the forwarded JWT).

Read more about authenticating your users in the full Kindly Chat authentication guide.

Supported versions

Major versions are released on a six month cycle and there will be no breaking changes outside of a major release.

We provide support for the latest two major versions.

We follow semantic versioning when naming versions of Kindly Chat.

Pure build

We also provide a special JavaScript build that does not pollute the global scope (window) to prevent possible conflicts with existing code. The script tag is almost identical to the main build, except the URL ends in -pure.js:

<script
    id="kindly-chat"
    src="https://chat.kindlycdn.com/kindly-chat-pure.js"
    data-bot-key="YOUR-BOT-KEY"
    data-shadow-dom="1"
    async
></script>

The side effect of this is that it does not add polyfills to support older browsers. This means you need to add the necessary polyfills to your own browser environment, to maintain support. This can be done using polyfill.io. The current polyfills we use in the main build, to allow Internet Explorer 11 (IE11) users to be happy, are:

import "core-js/features/weak-set";
import "core-js/features/promise";
import "core-js/features/object/values";
import "core-js/features/object/assign";
import "core-js/features/object/entries";
import "core-js/features/array/find";
import "core-js/features/array/find-index";
import "core-js/features/array/from";
import "core-js/features/string/starts-with";
import "core-js/features/symbol/iterator";
import "intersection-observer";
import "./polyfillCustomEvent"; // From https://developer.mozilla.org/en-US/docs/Web/API/CustomEvent/CustomEvent#polyfill