Customize the chat widget

Simple customizing

Open the widget by clicking on a button

1
<!-- Custom button anywhere on the page -->
2
<button onclick="BrevoConversations('openChat', true)">Chat with us</button>

Or you can create a link with the address #brevoConversationsExpanded:

1
<!-- Link anywhere on the page -->
2
<a href="#brevoConversationsExpanded">Chat with us</a>

Also, you can use any valid CSS selector as the customWidgetButton to assign the chat button behavior to the element of your choice (this will also hide the default chat button). The first step is to place the following snippet before the main widget code:

1
<script>
2
    window.BrevoConversationsSetup = {
3
        customWidgetButton: '.custom-chat-button'
4
};
5
</script>
6
7
<!-- Brevo Conversations widget code -->

Then add this selector to any element on the page:

1
<!-- Custom button anywhere on the page -->
2
<button class="custom-chat-button">Chat with us</button>

Change the widget’s width and height

Specify chatWidth and chatHeight (in pixels) before the widget code:

1
<script>
2
    window.BrevoConversationsSetup = {
3
        chatWidth: 400,
4
        chatHeight: 550
5
    };
6
</script>
7
8
<!-- Brevo Conversations widget code -->

Change the widget’s z-index

Use the zIndex setting to update the default z-index (set to 9999):

1
<script>
2
window.BrevoConversationsSetup = {
3
    zIndex: 10
4
};
5
</script>
6
7
<!-- Brevo Conversations widget code -->

See also the setZIndex method.

Change the chat button colors

Specify the colors before the widget code:

1
<script>
2
    window.BrevoConversationsSetup = {
3
        colors: {
4
            buttonText: '#f0f0f0', /* chat button text color */
5
            buttonBg: '#565656'    /* chat button background color */
6
        }
7
    };
8
</script>
9
10
<!-- Brevo Conversations widget code -->

Use a color picker to generate hex color codes.

Change the chat button position based on the screen width

1
<script>
2
window.BrevoConversationsSetup = {
3
    buttonPosition: window.innerWidth < 1024 ? /* width threshold */
4
        'bl' : /* chat button position on small screens */
5
        'br'  /* chat button position on big screens */
6
};
7
</script>
8
9
<!-- Brevo Conversations widget code -->

Use the following codes to set the chat button position:

• 'bl' – at the bottom of the screen, on the left
• 'bc' – at the bottom of the screen, in the middle
• 'br' – at the bottom of the screen, on the right
• 'lt' – on the left side of the screen, at the top
• 'lm' – on the left side of the screen, in the middle
• 'lb' – on the left side of the screen, at the bottom
• 'rt' – on the right side of the screen, at the top
• 'rm' – on the right side of the screen, in the middle
• 'rb' – on the right side of the screen, at the bottom

Embed the widget into a block

Specify id of the block you want to embed the chat widget into before the widget code:

1
<script>
2
window.BrevoConversationsSetup = {
3
    mode: 'frame',
4
    /* id of the block you want to embed chat into */
5
    injectTo: 'conversations-wrapper'
6
};
7
</script>
8
9
<!-- Brevo Conversations widget code -->

injectTo also accepts direct links to HTML nodes and array-like node collections (including NodeLists and jQuery collections). See injectTo description.

Place the block anywhere on the page:

1
<div id="conversations-wrapper"></div>

The only thing left is to set an appropriate block size, e.g.

1
<div id="conversations-wrapper" style="width: 100%; height: 500px;"></div>

Conversations will occupy the whole block.

Disable Conversations on mobile devices

Insert this code before the widget code:

1
<script>
2
window.BrevoConversationsSetup = {
3
    disabledOnMobile: true
4
};
5
</script>
6
7
<!-- Brevo Conversations widget code -->

Or look for “Mobile button” option in your widget settings and uncheck it.

Identifying existing users

Passing user details to Conversations

Use the updateIntegrationData method to update the visitor’s details in Conversation’s right pane. Use null to remove properties.

1
/* Anywhere after Brevo Conversations widget code */
2
BrevoConversations('updateIntegrationData', {
3
    email: 'cowardly_lion@yahoo.com', /* e-mail changed */
4
    firstName: 'John', /* first name changed */
5
    lastName: 'Doe', /* last name changed */
6
    phone: null, /* phone number removed */
7
    notes: 'Looking for courage...', /* notes property created */
8
9
    /* any number of custom properties */
10
    'trip wish list': 'Going to Oz with friends'
11
});

If custom properties set in updateIntegrationData match existing contact attributes, they will be synced in your Contacts database. If not, they will be available in Conversations only.

Binding conversations to user accounts

Conversations can recognize logged-in users regardless of the device or browser they use, so that a single conversation thread will be maintained. Also, if the user logs out and another logs in on the same device, the two different conversation threads will be kept separated.

To bind the widget to user accounts on your site:

1. Generate a unique random string for each user and save it to your database.

2. When the user is logged in, specify their string before the widget code like this:

   1
   <script>
   2
   window.BrevoConversationsSetup = {
   3
       /* current user’s generated string */
   4
       visitorId: 'kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg'
   5
   };
   6
   </script>
   7
   8
   <!-- Brevo Conversations widget code -->

❗️

visitorId must be unique and secret (i.e. not available to other users) as someone might use it to get access to a private conversation. It’s best to use randomly generated string. Do not use publicly known data such as user’s ID, name, email, etc.

Translating the widget

You can choose the widget language from Conversations’ settings and use Javascript API for more granular control (see language setting).

If the desired language is not supported or you wish to change some of the strings of an existing language, you can override one of the existing languages with your set of strings.

❗

Note, that adding unsupported languages as new properties to the locale object (“fi”, “sv”, “pl” etc.) is not possible.

Here’s our current locale file:
locale.json

Let’s say you want to change chat input placeholder text. Here’s how you can do it:

1
<script>
2
window.BrevoConversationsSetup = {
3
    locale: {
4
        chat: {
5
            input: {
6
                placeholder: 'Meddelande...'
7
            }
8
        }
9
    }
10
};
11
</script>
12
13
<!-- Brevo Conversations widget code -->

To change more strings, just add all of them to the locale property of BrevoConversationsSetup (adhere to the structure of the original locale file). If the language code key is not specified, phrases will be changed in all language versions.

1
<script>
2
window.BrevoConversationsSetup = {
3
    locale: {
4
        chat: {
5
            input: {
6
                placeholder: {
7
                    en: 'Message...',
8
                    /* overriding only the French phrase with the Swedish translation */
9
                    fr: 'Meddelande...'
10
                }
11
            }
12
        },
13
        contactAttributes: {
14
            firstName: 'Namn',
15
            lastName: 'Efternamn',
16
        },
17
        messageTypes: {
18
            joinedFirst: 'ansluten,
19
            joined: '{{#username}} anslöt',
20
            agentsOffline: 'Agents är offline'
21
        }
22
    }
23
};
24
</script>
25
26
<!-- Brevo Conversations widget code -->

You can change as many strings as you want. Bear in mind that strings with keys starting with _ are protected from changing.

You can also change the locale dynamically using setLocale method:

1
/* Anywhere after Brevo Conversations widget code */
2
3
BrevoConversations('setLocale', {
4
    chat: {
5
        input: {
6
            placeholder: 'Meddelande...'
7
        }
8
    }
9
});