Knowledge base widget - Getting started

Plans supporting knowledge base widgets

Professional
Business
Enterprise






The Knowledge base widget helps your readers access your Knowledge base without leaving your website or application.

NOTE

You can configure up to 10 Knowledge base widgets in a project. However, you can configure only one Knowledge base widget to a domain/website.


Integrating Eddy AI in Knowledge base widget with multi-lingual support

You can access Eddy AI within your knowledge base as a widget, in various languages including English (en-US, en-GB), French (fr), Spanish (es), German (de), Norwegian (no), and Dutch (nl), ensuring a seamless user experience.

Enabling Eddy AI in Knowledge base widget

  1. From the Knowledge base portal, go to Settings > AI Features > Eddy AI.

  2. Turn on the KB widgets check box.

Screenshot-Integrating_Eddy_in_KB_Widget_toggle_on_off

  1. Then navigate to the Widget and for a new widget, click New widget. For an existing widget, hover over it and click Edit ( ). Then, in the Configure & Connect tab, enable the AI Assistive search toggle.

Updated_Screenshot-KBWidget_AI_Assisitive_Search

4. Once done, click Save.

Screenshot-Integrating_Eddy_in_KB_Widget_with_multi-lingual_support

NOTE

There are three content levels available while you set up the Knowledge base widget, Project, Workspace, and Category. On selecting Category, you will not be able to view the Workspace dropdown in the Knowledge base widget of your project.

Using the Knowledge base widget, readers can:

1. Search for helpful articles
2. Contact support if they have a question
3. View suggested articles based on their context
4. Be directed to other resources using custom links


1. Search for helpful articles

Users can search your Knowledge base for articles that answer their queries using the Knowledge base widget, without moving away from their current screen. No context switching is needed.

2. Contact support if they have a question

Decrease the number of clicks, keeping the end-user from getting the needed help. Use custom links, and add an email or a link to support.

3. View suggested articles based on their context

Give end-users the information they need before they know they need it. Set up suggested articles that display depending on the page the end-user is on.

4. Be directed to other resources using custom links

Need to put a link to download an eBook? A link to Google Sheets? Adding a custom link to the assistant can direct an end-user anywhere.

NOTE

The Knowledge base widget will now open in the default browser language by default. If the default browser language is not available in the Knowledge base widget, the default language of the Knowledge base will appear.


Knowledge base widget settings

You can update the following Knowledge base widget settings in one place:

  • Installation & setup

  • Custom CSS

  • Custom JavaScript

  • URL mapping

NOTE

To optimize performance and reduce redundant calls, we've introduced a caching system set to refresh every 15 minutes. Consequently, any changes made to the Widget configuration will be applied once this caching period elapses.

The autosave option is available for navigation between the above tabs.



FAQs

Do we have to set up the widget when switching from a public to a private Knowledge base? Also, do we have to log in again to view articles on the Knowledge Base site?

When switching from a widget from a public to a private project, you do not need to set up the widget again. However, you will be required to log in to view an article on the Knowledge Base site.

To bypass the login requirement, you can use the JWT (JSON Web Token) feature in the widget configuration. For more information, refer to the article Setting up JWT SSO.

How do I embed a private knowledge base into another application?

Currently, embedding a private knowledge base directly into another application is not available. However, you can use the Knowledge base widget to seamlessly integrate your private knowledge base into your desired application.