How to Embed a Widget in Zendesk Help Center
Zendesk Guide lets you embed interactive widgets directly inside help center articles using the Source Code Editor. Add troubleshooters, calculators, product demos, and more to transform static knowledge base articles into interactive self-service experiences. This guide covers three methods -- the Source Code Editor for individual articles, Custom Pages for standalone widget pages, and Theme Settings for site-wide scripts.
Zendesk sanitises some HTML tags in articles
Zendesk Guide allows iframes in article source code but strips certain tags like <script>. Always use the iframe embed code (not the script embed method) when embedding in article bodies. The Source Code Editor preserves iframes on save.
1. Prerequisites
- •An active Embeddy account with at least one published widget.
- •A Zendesk account with Guide Manager or Admin permissions to edit help center articles.
- •Your Embeddy iframe embed code -- copy it from your widget's Embed tab in the dashboard.
- •Zendesk Guide must be activated on your account (included with Zendesk Suite or available as an add-on).
Your Embeddy iframe code:
<iframe src="https://embeddy.ai/webhost/WIDGET_ID?widget_props_id=PROPS_ID" width="100%" height="500" frameborder="0"> </iframe>
2. Method 1 -- Source Code Editor (Recommended)
The Source Code Editor in Zendesk Guide's article editor lets you insert raw HTML directly into an article. This is the fastest way to embed an interactive widget like a troubleshooter or calculator in a specific help center article.
Best for: Embedding interactive troubleshooters, product configurators, ROI calculators, or step-by-step decision trees inside individual knowledge base articles to help customers self-serve.
- 1
Open the article in Zendesk Guide
In Zendesk, click the Zendesk Products icon and select Guide. Navigate to the article you want to edit and click the Edit article (pencil) icon.
- 2
Switch to Source Code view
In the article editor toolbar, locate and click the Source Code button (it looks like
< >). This opens a modal where you can edit the raw HTML of the article. - 3
Paste your Embeddy iframe code
Position your cursor where you want the widget to appear in the article body and paste your iframe code. You can wrap it in a container div for styling:
<!-- Embeddy Interactive Widget --> <div style="margin: 20px 0; max-width: 100%;"> <iframe src="https://embeddy.ai/webhost/WIDGET_ID?widget_props_id=PROPS_ID" width="100%" height="500" frameborder="0" allow="clipboard-write"> </iframe> </div> - 4
Click OK to close the Source Code editor
Click OK in the Source Code modal. You should see a placeholder or rendered preview of your iframe in the WYSIWYG editor.
- 5
Save and publish the article
Click Save. If the article is a draft, click Publish to make it visible in your help center. The widget will appear inline within the article.
Tip: After saving, always preview the article in your live help center. The WYSIWYG editor may not render iframes accurately, but the published article will display the widget correctly.
3. Method 2 -- Custom Pages (Theme Editor)
For standalone widget pages or site-wide placement, use Zendesk Guide's Theme Editor to add your embed code directly to custom page templates. This is ideal for creating dedicated tool pages in your help center.
Best for: Creating a dedicated "Interactive Tools" or "Product Demo" page in your help center where the widget is the primary content.
- 1
Open the Theme Editor
In Zendesk Guide, click Customize design (the paintbrush icon), then click Edit theme to open the code editor.
- 2
Create or edit a custom page template
Navigate to Templates and select a page template (e.g.
custom_pages/my_widget_page.hbs). You can create new custom page templates here. - 3
Add your embed code to the template
Paste the iframe code into the Handlebars template where you want the widget to appear:
<div class="container"> <h1>Interactive Troubleshooter</h1> <p>Use our interactive tool to diagnose your issue.</p> <iframe src="https://embeddy.ai/webhost/WIDGET_ID?widget_props_id=PROPS_ID" width="100%" height="600" frameborder="0" allow="clipboard-write"> </iframe> </div> - 4
Save and publish the theme
Click Save and then Publish the theme. Your custom page will be available at
your-subdomain.zendesk.com/hc/p/my_widget_page.
4. Method 3 -- Script Tag via Theme Settings
To add a script-based widget (like a floating chat or pop-up tool) across your entire help center, inject JavaScript through the theme's document_head.hbs or footer.hbs template.
Note: This method adds code site-wide. Use it for floating/overlay widgets, not inline article content. For inline embedding in specific articles, use Method 1.
- 1
Open the Theme Editor
Go to Guide > Customize design > Edit theme.
- 2
Edit the footer template
Open
footer.hbsin the template list. Add your script just before the closing tag. - 3
Add your script snippet
Paste the script-based embed code to dynamically inject the widget:
<!-- Embeddy Widget - Site-wide --> <script> (function() { var iframe = document.createElement('iframe'); iframe.src = 'https://embeddy.ai/webhost/WIDGET_ID?widget_props_id=PROPS_ID'; iframe.style.cssText = 'position:fixed;bottom:20px;right:20px;width:380px;height:500px;border:none;z-index:9999;border-radius:12px;box-shadow:0 4px 24px rgba(0,0,0,0.15);'; document.body.appendChild(iframe); })(); </script> - 4
Save and publish
Click Save, then Publish the theme. The widget will now appear on every page of your help center.
5. Troubleshooting
Widget disappears after saving the article
Zendesk may strip certain HTML attributes on save. Make sure you are using the iframe embed code, not the script-based embed. Re-open the Source Code editor to verify your iframe tag is still present. If Zendesk removed it, check that your account permissions allow HTML editing in articles.
Iframe shows a blank white box
Verify the src URL is correct by opening it directly in a new browser tab. Also check that your Zendesk help center domain is not blocking iframes via Content Security Policy (CSP) headers. Contact your Zendesk admin to whitelist embeddy.ai if needed.
Source Code button is missing from the toolbar
The Source Code button is available in the full article editor in Zendesk Guide. If you are editing inline or using a restricted editor, switch to the full editor. You need Guide Manager or Admin role to access the Source Code editor.
Widget is not responsive on mobile
Set width="100%" on your iframe and wrap it in a div with max-width: 100%. Zendesk's responsive themes will handle the rest. You may also want to set a lower height value for mobile readability.
Script tags are stripped from the article body
Zendesk Guide does not allow <script> tags inside article content for security reasons. Use the iframe embed method for articles, or inject scripts via the Theme Editor (Method 3) for site-wide functionality.
6. FAQ
Can I embed an interactive troubleshooter in a Zendesk article?
Yes. Build your troubleshooter as an Embeddy widget, then embed it in any Zendesk Help Center article using the Source Code Editor (Method 1). Customers can interact with the troubleshooter directly in the article without leaving the help center.
Does the embedded widget work with Zendesk's restricted agents?
The widget is visible to all help center visitors, regardless of their agent status. Viewing embedded widgets does not require any Zendesk agent license. However, editing the article source code requires Guide Manager or Admin permissions.
Can I pass Zendesk user data to the widget?
Yes. In the Theme Editor, you can use Zendesk's Handlebars helpers (e.g. {{current_user.name}}) to pass user data as URL parameters in the iframe src. This only works in theme templates, not in article source code.
Will the widget slow down my help center?
No. Iframes load asynchronously and do not block the main page render. The widget loads in its own sandboxed frame, so it has no impact on your help center's page speed or performance.
Can I embed a calculator or product demo in my Zendesk knowledge base?
Absolutely. Embeddy widgets are ideal for embedding interactive tools in support articles. Build a pricing calculator, product configurator, or interactive demo in the Embeddy dashboard, then embed it in the relevant Zendesk article. Customers can use the tool without leaving the help center.
Ready to embed in Zendesk?
Create interactive troubleshooters, calculators, and product demos with Embeddy's no-code builder and embed them in your Zendesk Help Center in minutes.
Start for Free