Inkeep light logo
Schedule a callSee it for my content
IntegrationsHelpscout

Add Chat and Search to Help Scout

Integrate Inkeep's chat button and search bar into your Help Scout knowledge base for enhanced user experience.

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

  1. Click the Manage dropdown in the top bar, then select Docs
  2. Select the knowledge base you would like to add the widget to
  3. 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>

Initialize the widget

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");
 
  const config = {
    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) {
      Inkeep.ChatButton(config); // initialize the ChatButton widget
      const searchEl = document.getElementById("searchBar");
      searchEl && Inkeep.SearchBar("#searchBar", config); // 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 Common Settings.

Add Search Bar to Help ScoutAdd an AI chatbot to your Discord server

On this page