Contextual Help is a Web Widget feature that uses the web page your visitor is currently on, along with your Help Center content, to suggest Help Center articles that may be relevant to their questions. Its goal is to reduce the effort of an end-user who might be trying to self-serve by suggesting contextually relevant articles.
The example below shows how the Web Widget uses Contextual Help to populate the widget with relevant articles as the user browses to a web page about the REST API:
This article includes the following topics:
Enabling Contextual Help
Before you can enable Contextual Help, make sure you meet the following requirements:
- You have public Help Center content (not requiring log-in) or restricted Help Center content that you have configured to be accessed via the Web Widget.
- The Web Widget is installed on your website.
- You have enabled Help Center option in the Widget admin.
To enable Contextual Help
- Open the Web Widget Admin page by clicking the Admin icon (
) in the sidebar and selecting Channels > Widget. - Click the Customization tab.
- Make sure that Help Center is toggled on.
- Click the toggle to enable Contextual Help.
Understanding how Contextual Help works
The Contextual Help feature determines which articles should be suggested by looking at URL of the web page the end-user is on It then uses the part of the URL after the hostname (that is, the part after .com, .org, etc.) to perform a search on your Help Center to find relevant articles, and displays the first three results as Top suggestions. Community posts are not included in the suggested articles list.
For instance:
- If an end-user is viewing the page myshop.com/apps, the suggested articles will include the first three results of a Help Center search on the term "apps".
- If an end-user is viewing a page deeper in your website, for instance myshop.com/account/billing, the suggested articles will include the first three results of a Help Center search on the term "account billing".
-
If no articles match the search term, just the search box is displayed in the widget.
Customizing Contextual Help results
If your URL paths are not likely to produce useful suggestions, or if you just want more control over the results, you can override the search by utilizing one of our SetHelpSuggestions API methods.
For information on customizing your results, visit our Web Widget Developer Documentation.
Comments
22 comments
Does contextual help search tags too, or just words in the actual article?
Chat lives on pages like this
https://live.taketheinterview.com/my_interview?code=3dcd3646deb02fbddd58dad1e1fd4969#login
How can we get related articles to populate? Right now it is wrong.
@robert Contextual Help uses the same search as your Help Center Knowledge Base. I've created a ticket for your question so we can look into your specifics with you.
We're seeking to embed the contextual help into our online app. We'd like to filter the results by the article's label and then by a language search within that label.
Is that possible with the Widget API? (If not... I'd like to offer that kind of two-tiered filter as a suggestion!)
Scott, the Web Widget automatically keys to the browser language so I expect that it would display articles of that language that use the label included in zE.setHelpCenterSuggestions. Is that not what you are finding?
I am having the same issue as mentioned here https://support.zendesk.com/hc/en-us/community/posts/218033707/comments/226504588 . When navigating between pages in an SPA, previous 'Top suggestions' stay in the widget until a later suggestion is found. This is a major problem for an SPA with many routes - I can't guarantee that all of them will find their own top suggestions, and if the old suggestions stay in the widget then that is simply confusing for end users.
Is there any plan to either automatically clear the top suggestions when calling setHelpCenterSuggestions , or to offer a 'resetSuggestions' function? I'd really like to avoid having to roll our own widget using the apis!
Hey Sybil -
Welcome to the Zendesk Community!
I've taken a look at the ticket that was created for Dave, and it seems that in his case it was an issue within the way his app was coded. Because it's such a one-off problem, I'm going to go ahead and create a ticket for you so that our support team can do the appropriate troubleshooting for you. Look for an email from me shortly.
Can you use *wildcards in the URLs? For example, if we have thousands of custom URLs like /study?deck_id=12345&pack_id=54321 , and we want a particular contextual Help message to show up on ALL pages whose URL is "like" /study* , is that possible?
If so, this should be heavily mentioned in this Help article, as I'm sure it's pretty important for a lot of companies!
Also, does contextual help work in the mobile SDK?
Hi Andrew, the native functionality works off URL. You could try custom code with zE.setHelpCenterSuggestions https://developer.zendesk.com/embeddables/docs/widget/api#ze.sethelpcentersuggestions
For the mobile SDK there are ways to show a single article but the feature "contextual help" only relates to the web widget.
Thanks for this, @Daniel. But I'm not sure that documentation answers my question about wildcards. In all of your examples above and elsewhere, it's assuming that the widget lives on pages with clean URLs, such as /pricing.
But what if, say, we have a unique URL for each user (e.g. with the user's ID in the URL), such as /pricing?user_id=12345, /pricing/?user_id=54321, etc.?
Is there a way we could just create a *single* widget condition for all pages like /pricing* , using the * character (or % ?) as a "wildcard"?
Hi Andrew let me create a ticket for you and we discuss further there.
Hi Daniel, I never received the ticket. Please note that the Admin account we're using is info@brainscape.com (but you can also use this email address for Andrew Cohen for just support, even if it doesn't have a Zendesk admin or agent account). Thanks!
Hi Andrew, looks like our Advocates are taking care of you with ticket ID #3052923.
To work off of the original comment by Robert Koch, does/can Contextual Help take the ending URL and match with a label in our Guide Knowledge Base?
So if I were to use the Guide KB labels to match URL endings would end users get more accurate Contextual Help results?
Hi Ryan, no Contextual Help does not match the ending URL to a label. If you want to use specific labels I'd recommend using the API zE.setHelpCenterSuggestions.
https://developer.zendesk.com/embeddables/docs/widget/api#ze.sethelpcentersuggestions
I'm having the same issue as Andrew Cohen above.
How do you handle URLs that include a user's ID and additional parameters?
Can you share your answer?
Hi all,
can I set top suggestion article on web widget for more than 3 articles?
Thanks
Hi Tri,
No, that is not a customizable function. However, the "view more" button should suffice to show users additional content if needed.
Hi Daniel and Nicole,
I have the same issue as Andrew. Some of our URLs have a User ID or other identifying ID (e.g. www.smarterselect.com/forms/453423) and we want the contextual help to ignore the IDs and just focus on "forms". I've not found any info in the Q&A or Community. How did you guys figure it out with his "ticket ID #3052923"?
Many thanks,
Robert
Hey Robert,
Here's the solution that Andrew received from our Customer Advocates:
"About Contextual Help for the Web Widget outlines that we use whatever is in the URL after the hostname to search. In your case, since you are adding additional information that would not likely produce useful suggestions, I would recommend following the workaround provided under "Customizing Contextual Help results" by overriding the search by utilizing one of our SetHelpSuggestions API methods.
For information on customizing your results, visit our Web Widget Developer Documentation (this is a Javascript API that you add code to the webpages to modify the behavior.)
For any /pricing?user_id=12345 type URL you can add in a zE.setHelpCenterSuggestions function in your site's code to set what search options you want that page to be using instead of the URL."
Let me know if that helps, or if you have further questions.
Hi Nicole,
Thanks!
RD
We just deployed a minor enhancement to the Web Widget Contextual Help that should improve results returned in scenarios where URLs include IDs or other numeric strings. Please let us know how you go!
Please sign in to leave a comment.