Skip to main content

Unify all external content with our Federated Search API

Related products: CC Search
Unify all external content with our Federated Search API

At inSided, we believe that unifying all customer success content in one place empowers your customers to be successful and increases self-service rates. To do so, we’ve already built some native integrations to bring content from Zendesk, Freshdesk, Skilljar, Thought Industries and more. On top of that, we’re now opening up our Federated Search API to allow you to bring any external content to your customer hub.

What’s new?

Using our federated search API you can now push any external content into our search engine and unify the search experience by showing the most relevant results, no matter where it comes from.

 

With the Federated Search API, you can:

  • Push any external content to the inSided search engine

  • Categorize and differentiate external content by source (e.g. Academy, Docs, Help center, Blog)

  • Display external content in the live-search dropdown and search result page

  • Directly navigate to external content from the inSided platform

  • Filter search result pages between community results and external results

Note: Federated search via API is a paid add on. Please contact your CSM to start using it.

How do I set it up?

Learn more about setting up federated search through the API in our Knowledge Base article. This page also links to our API docs, where you’ll learn how to include the title, content, url and source.

https://community.insided.com/integrations-124/how-to-show-external-content-in-the-search-results-federated-search-4065 

💡 Customer spotlight

Unqork, one of our customers who was in the beta for this feature, has set up the Federated Search API so that they pull in courses from their academy, and help articles from their external knowledge base. Want to see it in action? Head over to community.unqork.com!

 

The udpate states - 

  • Categorize and differentiate external content by source (e.g. Academy, Docs, Help center, Blog)

How do you categorize the content, the link doesn’t say how. A

Also, can we change the icons by category type?


  1. We’ve been using this in the beta and it’s awesome! I’m glad it’s now GA. We have a forthcoming Case Study article that will be published to talk about our use case. 
     
  2. +1 on @KellyBebenek’s comment. Categorizing the content was one thing I wished we had, and didn’t know we could do that. Would love some documentation on how to do that. 

The udpate states - 

  • Categorize and differentiate external content by source (e.g. Academy, Docs, Help center, Blog)

How do you categorize the content, the link doesn’t say how. A

Also, can we change the icons by category type?

@KellyBebenek (cc @DannyPancratz), we’ve updated the API docs and the FAQ section in our KB article to help you out with this. I’ve copied the instructions from there below:

You need to add ‘source’ to the payload through the API (see example below). After that, it will show the source you entered there (i.e. externalAcademy) as a category in the search results. You can then use Phrases to change that name to a friendly name (i.e. Academy).

 


Thanks, @Sebastian. This seems like a great improvement and I’m excited to work with our team to try it out.