Using the Widget for Contextual Help: Pages to Recommend On

Pages to Recommend On allows you to provide contextual help to your readers via the embeddable contact form widget or the API. The basic idea is that you can provide a list of relevant articles based on the page the person opened the widget from--and maybe eliminate the need for them to search or contact you. You can relate  individual articles to pages in your knowledge base, website, or application so that they are suggested when the widget loads on the page or you use the API to return articles for a particular page in your site. For example, if you associate articles with the "/pricing" page on your website, these articles will appear if the embeddable contact form is loaded on this page. Alternatively, if you associated articles with the "/account" page in your application and used the API to pull articles for that page, these articles would be returned for your account page.

This is displayed differently depending on which widget type you've selected.

If you're using the Modern widget, this will impact the Suggested Articles header section (note: in Settings > Widget, you can designate a different name for this section, so it may be called something else):

Screenshot showing the Modern Widget, with callout to the Suggested For You sectionSample Modern widget, Suggested For You section

If you're using Widget 2.0, this will update the Recommended tab list:

Screenshot showing Widget 2.0 opened to the Recommended tabWidget 2.0, Recommended tab

Setting up pages to recommend on

You will need to know the relative URL of the pages in the application or website that you are calling the widget or API from. If we are configuring articles for https://www.knowledgeowl.com, we will only take the portion of the URL that comes after that URL. For example, https://www.knowledgeowl.com/pricing becomes "/pricing". 

Once you have the relative URL for pages you want to specify recommended articles for, open one of those articles in the article editor in KnowledgeOwl.

Add the relative URL to the Recommend On Pages section and Save.

If you want this article to be recommended on multiple pages in your application or website, add each relative URL on a separate line:

If your website or application includes URLs that have a variable ID field in them, you can replace that ID with {id} in your URL:

Note: {id} only works with numeric and hexadecimal IDs. For IDs that don't match either of those patterns, you would need to use the {custom} option via regex.

Be sure to Save the article. The next time someone opens the widget from one of those pages in your site or application, it will suggest this article.