Add Search Bar to Help Scout

What is Help Scout

Help Scout is a customer service solution for handling support tickets.

Get an API key

Follow these steps to create an API key for your web integration.

Connect the script

Click the Manage dropdown in the top bar, then select Docs
Select the knowledge base you would like to add the widget to
Click Custom Code in the left sidebar

In the Insert <head> Code section, copy and paste the code below:

<script
  id="inkeep-script"
  type="module"
  src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js"
  defer
></script>

Next, in the same section, paste the following code:

<!-- hide the helpscout search button -->
<style>
  #searchBar button[type="submit"] {
    display: none;
  }
</style>
 
<script type="text/javascript" defer>
  const inkeepScript = document.getElementById("inkeep-script");
 
  // configure and initialize the widget
  const addInkeepWidget = (targetElementId) => {
    const inkeepWidget = Inkeep.SearchBar(targetElementId, {
      baseSettings: {
        apiKey: "INKEEP_API_KEY", // required
        primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
        organizationDisplayName: "Inkeep",
        // ...optional settings
        theme: {
          // optional styles to make the search bar look more like the helpscout search bar
          styles: [
            {
              key: "main",
              type: "style",
              value: `
                .ikp-search-bar__button {
                  background: white;
                  height: 50px;
                }
              `,
            },
          ],
        },
      },
      modalSettings: {
        // optional settings
      },
      searchSettings: {
        // optional settings
      },
      aiChatSettings: {
        // optional settings
        aiAssistantAvatar: "https://mydomain.com/mylogo", // use your own ai assistant avatar
        exampleQuestions: [
          "Example question 1?",
          "Example question 2?",
          "Example question 3?",
        ],
      },
    });
  };
 
  inkeepScript.addEventListener("load", () => {
    if (document.body) {
      const searchEl = document.getElementById("searchBar");
      searchEl && addInkeepWidget("#searchBar"); // initialize the SearchBar widget
    }
  });
</script>

Save custom code Click on the Save button. Navigate to your help

center to make sure the widget is installed correctly.

For a full list of customizations, check out the Search Bar documentation.

Add Search Bar to Help Scout

What is Help Scout

Get an API key

Connect the script

Initialize the widget

Save custom code Click on the Save button. Navigate to your help

On this page