About Contextual Help for the Web Widget Follow

Comments

24 comments

  • Avatar
    Robert Koch

    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. 

  • Avatar
    Erica Wass

    @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. 

  • Avatar
    Scott

    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!)

  • Avatar
    Erica Wass

    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?

  • Avatar
    Sybil

    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! 

     

     

  • Avatar
    Nicole - Community Manager

    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. 

  • Avatar
    Andrew Cohen

    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!

  • Avatar
    Andrew Cohen

    Also, does contextual help work in the mobile SDK?

  • Avatar
    Daniel Aron

    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.

  • Avatar
    Andrew Cohen

    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"?

  • Avatar
    Daniel Aron

    Hi Andrew let me create a ticket for you and we discuss further there.

  • Avatar
    Andrew Cohen (Edited )

    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!

  • Avatar
    Daniel Aron

    Hi Andrew, looks like our Advocates are taking care of you with ticket ID #3052923.

  • Avatar
    Ryan Walsh

    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?

     

  • Avatar
    Daniel Aron

    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

  • Avatar
    Noam Mahler

    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?

  • Avatar
    Tri Ardini

    Hi all, 

    can I set top suggestion article on web widget for more than 3 articles?

    Thanks

  • Avatar
    Nicole - Community Manager

    Hi Tri, 

    No, that is not a customizable function. However, the "view more" button should suffice to show users additional content if needed. 

  • Avatar
    Robert Davis

    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

  • Avatar
    Nicole - Community Manager

    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. 

  • Avatar
    Robert Davis

    Hi Nicole,

    Thanks!

    RD

  • Avatar
    Daniel Aron

    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!

  • Avatar
    Paul Reeves

    This doesn't seem compatible or complimentary to Chat. Is that correct? We have an offline message when an agent is not available and our widget displays that message, not contextual help. 

    Our CSS template has a related articles area next to our content (like this page). I assume that's a simplistic implementation of contextual help?

  • Avatar
    Nick

    Hi Paul,

    You are correct in that this does not apply to the Chat-only widget. Contextual Help is managed within Support under the Web Widget settings. You can offer the Contextual Help feature, a Contact Form, and Chat, all from the same Widget if you have both a Support and Chat account. 

    Seeing as you have access to the CSS template, this leads me to believe you have access to Guide, which you cannot access unless you have a Support account. Therefore, I would recommend utilizing the Web Widget instead of the Chat-only widget.

    If for some reason you require the Chat-only widget, you could then build your own widget with the Web SDK and possibly implement a reference to your Help Center articles via the Help Center API. This would require a high level of custom-coding however.

    I hope this provides some clarification for you. Let us know if you have any other questions!

Please sign in to leave a comment.

Powered by Zendesk