Adding Synonym Sets to Help Center search for Guide


  • Jennifer Rowe
    Zendesk Documentation Team

    I love this idea! thanks for sharing it, Andrew.

  • Heather Rommel
    Community Moderator
    Zendesk Luminary
    The Product Manager Whisperer - 2021

    This is fantastic! Thank you!

  • Vlad
    Community Moderator
    The Wise One - 2022

    Awesome! Thank you, Andrew!

  • Amy Gracer

    Finding lots of misspellings in my search results, so I wanted to give this a try. I added it to my JS, but still not getting the synonym results. 

    Any tip on what I might have done wrong?


    $(document).ready(function() {

    var synonymsets = new Array();
    function NewSynonymSet(key, synonyms) {
    var synonym = new Object();
    synonym.primary = key;
    synonym.keywords = synonyms;

    function ChangeSearch(val)
    var q = $(val).val();
    var query = q.toLowerCase().split(' ');
    for (var i = 0; i < query.length; i++) {
    for (var x = 0; x < synonymsets.length; x++) {
    var primary = synonymsets[x].primary;
    var keywords = synonymsets[x].keywords;
    if ($.inArray(query[i], keywords) > -1) {
    query[i] = primary;
    var newQuery = '';
    for (var i = 0; i < query.length; i++) {
    newQuery += ' ' + query[i];

    function InitializeSynonyms() {
    //always lowercase and can handle misspellings too.
    //Enter as many of these lines below as needed with different synonym sets
    NewSynonymSet('receiving', ['recieving', 'receivings', 'recievings',]);
    NewSynonymSet('commission', ['commissions', 'comission', 'comissions', 'commision', 'commisions']);

    $('#query').on('keyup', function () {
    $('#query').on('paste', function () {

    //End synonyms

  • Alejandro Colon

    Active Feature Request (please vote):

    Feature Request: Add the ability to add Synonym Sets to Help Center search for Guide


    I just posted a Feature Request for this at the link below. If you would like to see this feature please head over there and show your support. Please make sure to add an upvote and comment even if it is simply a "+1"

    Also, you may consider adding it to your post to get the feature request more visible.

  • Louis Eloff

    Hi all,

    I am currently trying to solve the same challenge, especially with misspellings.

    I have added the above code to our script.js on the Guide site, but it seems to only work for one of the "synonyms" in my test list. I added a few synonym lines below the sample ones, as follows, but it only works for the 2nd one (Sleep), when I search for "slep" on the HC. The others all say "No results" when searching. I made sure that articles exist for the primary words. Any ideas what I might be doing wrong? Thanks in advance!!

       NewSynonymSet('pre-authorisation', ['preauth', 'pre-auth']);
    NewSynonymSet('sleep', ['sleeep', 'slep']);
    NewSynonymSet('physiotherapy', ['physiotheraphy', 'Phisiotherapy']);
    NewSynonymSet('parents', ['parants', 'perents']);
  • Brett Bowser
    Zendesk Community Manager

    Hey Louis,

    It looks like you've yet to receive a response related to your question.

    While we at Zendesk are rather limited on what we can assist with on our end, we do have some great documentation that may help point you toward the desired solution you're looking for. 

    If you don't have the necessary resources available to assist with customizing your Help Center, we do have a Professional Services team that can assist at an additional cost. This is something you'll want to discuss with your account manager so if you're interested, I'm happy to get you in touch if needed.



Please sign in to leave a comment.

Powered by Zendesk