Embedded help center workflow | Community
Skip to main content

Embedded help center workflow

  • July 5, 2022
  • 3 replies
  • 0 views

Andrew36
It's not clear to me that the API for the help center can handle what i'm talking about, so I just wanted to get someone to give an up or down call.
 
Essentially I want...
 
1) A user clicks a help button on *our* website and open a side panel
2) In that side panel, there is a search bar (can build our own, or use the web widget if that works)
3) When a user searches, it displays the top relevant results. We would like to manually "fix" this process by associating certain search terms with certain responses. So it works on its own for the most part, but we can intervene if necessary. 
4) When they select an article, the article displays *in the side panel*. So it would need to be embeddable, or something like that.
 
Hoping to get a response in the form of...

-"yeah you can customize every step, here are the appropriate docs to get you started"
-"Steps one through three are fine but you can't do four, maybe try this instead..."
-"You could but that would be a lot of extra work for nothing, try this instead..."
-"On the professional plan you can only do this this and this, but if you upgraded here are the API docs which would let you build it", etc...

3 replies

Eric27
  • July 11, 2022
Hey there,

This is totally doable on any plan level. 
 
The best method to do this would be to use the list articles api to create an index of all of your publicly available articles. Use this api's response to function as your db for the search bar's source. It will also include the article body in raw html as part of the object so you could pretty easily build this into your own view. 
 
For manually "fixing" I'd suggest using article labels (Only available on professional and enterprise), to create an easy way of pulling the one's you'd like on certain terms.
That way you could create an array of terms that if searched correlate to a particular article label (i.e. you have a bunch of search terms about fruit, if someone search includes one of those terms, return all of the articles with the label "Fruit").
 
 
Hope this helps lead you in the right direction. 

Andrew36
  • Author
  • August 8, 2022

I appreciate your help here!

:)


Eric27
  • August 9, 2022
Happy to help!