The Web Widget can be added to any page of your website, or to your Zendesk Support Help Center.
The Web Widget is fully optimized for the mobile experience and does not affect page load times. The widget is presented in the end user’s language, according to the language setting for end user’s web browser. You can force the widget to always appear in a specific language (see Displaying your widget in a different language).
This article contains the following topics:
Related articles:
You cannot use SSO authentication in the Web Widget itself. However, you can restrict access by setting up SSO on your Help Center, or on the website hosting the widget. See Single sign-on options in Zendesk, and Using restricted Help Center content with the Web Widget.
Adding the widget to your website
You can add the Web Widget to any page of your website. After you add the code, you manage changes in Zendesk Support and with the Advanced Customization JavaScript APIs, and updates are reflected in the widget wherever it appears.
To add the Web Widget to your website
- Click the Admin icon (
) in the sidebar, then select Channels > Widget. - Click the Setup tab, if it is not already selected.
- Under the code box, click Copy to clipboard:
- If you want to add the widget to your website, go to the web page where you want to add the widget, then paste the code before the closing HTML </HEAD> tag.
You need to add the code to every web page where you want the widget to appear.
If you haven't already, make sure you configure the components in your widget.
Adding the widget to your Help Center
Adding the Web Widget to your Help Center also allows you to monitor usage initiated from the widget. For more information on using Insights to track Web Widget usage, see the following articles:
To add the Web Widget to your Help Center
- Click the Admin icon () in the sidebar, then select Channels > Widget.
- Click the Setup tab, if it is not already selected.
- Click the Add to Help Center toggle.
This adds the Web Widget to your Help Center header code, and displays the widget on every page of your Help Center:
If you are on a Team, Professional, or Enterprise Support plan, you can restrict the pages of your Help Center the Web Widget appears on via the Web Widget API, by modifying the zE.hide method. See Advanced Customization of your Web Widget and the Web Widget API documenation for more information.
Comments
8 comments
Hey!
the code to cut and paste "To add the Web Widget to your website" is not available. I would appreciate if you can send me a line to download for testing on my website.
Thanks
Hi, Matthew. If you go to Admin > Channels > Widget > Setup, do you see the code, along with the "Copy to clipboard" button?
Can I add the widget before I activate my Help Desk?
Hi Emily,
You sure can add the widget to your Guide platform prior to activating it. It just won't be visible to the public until you've activated Guide. :)
If you go to Admin > Channels > Widget > Setup there is a little toggle button which will automatically add the widget to your Guide platform for you. Alternatively you can do it manually by copying the code and pasting it into the Guide site code from your Guide admin area.
Hope this helps. :)
Hi Amie,
When I follow those steps and go to "set-up" I don't see the toggle.
Hi Emily! Welcome to the Community!
When you click on the Set-up tab in your Widget settings, you should see a little slider button in the lower right corner of the window:
Let us know if you're still having trouble! If you can post a picture of your settings, that would be really helpful. :)
I'm also not seeing the button that you're mentioning. Any ideas?
Hey Sean -
Welcome to the Zendesk Community! Is your Help Center enabled? That toggle doesn't show up until it is.
Please sign in to leave a comment.