Suite | Any plan |
You can configure a number of appearance-related settings for the Web Widget from the Style tab of the Web Widget page.
This article includes the following topics:
Configuring the widget frame
The Web Widget frame includes the structural elements of the window through which customers conduct messaging conversations with agents. You can define where on the page the frame is located, select colors for text and frame elements, upload a logo, and more.
To update the widget frame
- In Admin Center, click
Channels in the sidebar, then select Messaging and social > Messaging.
- Click the name of the channel you want to edit. The widget’s edit page opens.
- Click the Style tab and configure the following settings:
- Primary color , the main color of the launcher button and widget header. Enter a hexadecimal number, or click the color swatch to open a color picker. If you're migrating from Web Widget (Classic), the color defaults to that brand's widget settings.
- Position, the location of the widget and launcher on your website or help center. Select Bottom left or Bottom right, then enter the offset spacing from the bottom and side of the page. The default position is 16px from the selected option.
- Border, the border radius, or curve, of the outer edges of the widget. Use the slider to select a radius from Straight corners (0 px) to Curved corners (20 px).
- Message color, the color of the bubble around customer messages. Enter a hexadecimal number, or click the color swatch to open a color picker.
- Action color, the color of any buttons or customer actions (such as a selected option). Enter a hexadecimal number, or click the color swatch to open a color picker.
- Attachment permission for customers. Select the checkbox to allow customers to add attachments to messaging conversations. Deselect to prevent customers from adding attachments. Attachments are allowed by default.
- Logo (optional), a JPG or PNG to appear at the top of the frame. The logo is the visual identity of the conversation flow. Click Upload image, then browse to the image you want to add.
- Title, the name that appears at the top of the frame. This might be a call to action ("Contact us") or your business name.
- Description (optional), a short piece of text under the title. This can be information you want to share, or a tagline, for example. Enter the description in the text box.
- Show Zendesk logo, which switches on and off the Zendesk logo on a web widget or mobile channel. Available for Suite Enterprise accounts.
- Sound notifications (Web Widget only), which activates audio alerts for your customers when they receive a response from a live or AI agent in an inactive Web Widget messaging conversation. When activated, customers can choose to disable sound notifications on their end of the conversation.
- Click Save settings.
Configuring the widget launcher
The Web Widget launcher is the button the customer clicks to open the widget. You can define where it appears on the web or help center page, its shape, text, and more.
You can also use the Web Widget API to create a custom Web Widget launcher and define how it behaves. See Web Widget API for more information.
To update the launcher
- In Admin Center, click
Channels in the sidebar, then select Messaging and social > Messaging.
- Click the name of the channel you want to edit. The widget’s edit page opens.
- Click the Style tab.
- Update the Position in browser window, where the launcher button appears in your browser window. Use the radio buttons to choose either Bottom right or Bottom left.
- Update Shape (Web Widget only), the shape of the launcher button.
Choose one of the following:
- Square: Use the slider to adjust the curve of the outer edges of the square launcher button.
- Circle
-
Custom launcher Note: Selecting Custom launcher removes the launcher from your website or help center. You can then add the launcher to your web or help center pages using the open, close, and unread messages APIs. See Web Widget API.
- Text (optional), text that appears next to the launcher button
- Show on mobile, select to display the text in a mobile SDK.
- Click Save settings.
57 comments
Chris Evans
Hi all,
I'm unable to add any customisation to my widget. I've followed all of the suggested methods from https://developer.zendesk.com/api-reference/widget/api/, and also tried accessing the zIndex property from window.zE. I always put the window.zESettings script directly before the main snippet.js script, but no colours ever change.
To demonstrate the issue, I've created a code sandbox: https://codesandbox.io/p/sandbox/admiring-colden-44k5kk
I've tried two approaches: 1. setting the scripts directly in index.html (currently commented out), 2. Creating a widget component in React. Both approaches set the widget, but neither can change the colours of the widget. I have removed our account key, so you will need to swap in a working key to see the widget.
I have a couple of questions regarding this:
1. Is there an example anywhere of a working web widget with JS customisation? So I can view the code. I'm aware of the one in your quick start guide, but that is exactly what I tried -- the settings script before the main script. Tried in both html and javascript.
2a. Is there a way to know if I'm using the classic web widget or not? It seems as though you have a classic version and a newer version, if I'm understanding correctly.
2b. Should the newer web widget be customised in a different way, or should it also be customised via a script that sets window.zESettings?
3. Any other tips / things I can check would be useful to know.
0
Tony
I'm not too sure that's possible at the moment. You might want to create a post as feedback, so our team can check that out!
Best,
0
Liam Kelly
How do we change the orientation of articles in the widget? It is odd that they display horizontally in such a narrow window.
0
Christine Diego
If you have the Web Widget (Classic) or current Chat widget, at this time it is not possible to customize the shape or size of the Web Widget (Classic). If you have the Legacy Chat widget You can change the size between small, medium and large from the Chat dashboard. You can check this article for details How do I change the shape and size of the Zendesk widget?
0
貴一 徳永
Hello. Is it possible to change the size of the Zendesk widget? It doesn't matter if it's the old version or the new one.
0
Permanently deleted user
Hi 1263082160589
Ahh I got it, Thank you!
0
Hiedi Kysther
Hi 1267965790010

It will apply all settings set in the Messaging - Style section in Mobile SDK.
0
Permanently deleted user
Hi, 1263082160589
and what will show on Mobile?
is it the text "Hi, Need any help?" or what?
Thanks
0
Hiedi Kysther
Hi 1267965790010,
That setting is for Mobile SDK. If you have Mobile SDK and that option isn't enabled then that setting will not show in your app.
0
Permanently deleted user
What is this checkbox (Show on Mobile) for?
0
Sign in to leave a comment.