Contextual Help Widget (2.0)

Embed a widget of your knowledge base in your website, company intranet, or web-based software application to show knowledge base content where your users need it most.

Articles

Widget 2.0 overview
One of the biggest concerns folks have when adopting a knowledge base is that toughest of questions: how do I get people to actually use my documentation? Requiring users to go to yet another website--like your KnowledgeOwl knowledge base--seems lik...
Widget 2.0 display settings
To get started with the web widget, go to Settings > Widget . First, you'll need to decide how you want your website users to access the widget. We offer two options: An automatic circular "?" icon Attach the widget to an eleme...
Widget 2.0 installation
Once you've configured and saved your widget settings, you'll need to add the widget embed code into your website or web-based application: Scroll to the bottom of Settings > Widget . Copy the Widget Embed Code in the box at the botto...
Customize widget tabs, headers, and text
In Settings > Widget , the Customize Text section allows you to change a variety of text fields: The Knowledge, Recommended, and Contact tab labels The header text displayed in the Knowledge and Recommended tabs The Open in full site and Scr...
Customize widget contact form
In Settings > Widget , the Contact Form section allows you to change some of the text labels and placeholder text in the widget's Contact tab, including: Field labels Search results header Thank you message Add a custom footer Wid...
Widget authentication--when and how to use it
If you're thinking of using the embeddable web widget, you'll need to consider: Whether you need authentication for the widget Which type of authentication method to use Since the answers to these question involve a few variables, here ...
Widget 2.0 JWT authentication
When using the widget with private knowledge bases, or knowledge bases that have restricted content that you want your customers to be able to access, SSO authentication is required. To implement SSO authentication for your end-users in the widget,...
Widget 2.0 Oauth2 authentication
When using the widget with private knowledge bases, or knowledge bases that have restricted content that you want your customers to be able to access, SSO authentication is required. To implement SSO authentication for your end-users in the widget,...
Customize the widget look and feel
In addition to changing the widget tabs, labels, and headers by using the built-in settings, you can also customize its look and feel using CSS and Javascript. Settings > Widget offers custom widget styles (CSS) and custom widget Javascript ...
Using Widget 2.0 on Single Page Applications
The Problem If you've set up "Recommend on Pages" for contextual help , by default, when an end-user navigates to a new page, the widget grabs that URL and uses it to suggest content in the Recommended tab . This method works fine f...
Open widget to specific tab
By default, the widget will: Open to the Recommended tab if there are any recommended articles for the current page Open to the Knowledge tab if there are no recommended articles for the current page You can open the widget to a specific tab ev...
Hide one of the Widget 2.0 tabs
Use this custom CSS to hide one of the tabs in Widget 2.0.
Open widget to a specific article or category
Some customers like to be able to open the widget directly to a specific article or category. The steps for each are quite similar. To open the widget to a specific article, you'll need to use two methods: _ko19.openArticle('article-iden...
Prepopulate Widget 2.0 Contact Form fields
Learn how to use the updateContact method to pre-populate the email and name fields in Widget 2.0's contact tab.
Advanced option: add the widget in your own div wrapper
Learn how to define a custom div wrapper for your contextual help widget to better control the widget's height and overall placement.
Transition checklist: from Modern Widget to Widget 2.0
Here's a list of key considerations if you're considering or planning to upgrade from using the Modern Widget to Widget 2.0:   Update Widget Settings to use Widget 2.0 (Settings > Widget, select Widget 2.0 rather than Modern Widge...
Modern Widget vs. Widget 2.0 Comparison
See a side-by-side comparison of the feature sets each contextual help widget offers.