Inkeep light logo
Schedule a callSee it for my content
IntegrationsHelpscout

Add Chat Button to Help Scout

Integrate Inkeep's chat button into your Help Scout knowledge base for real-time user assistance.

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:

<script type="text/javascript" defer>
  // configure and initialize the widget
  const addInkeepWidget = function () {
    const inkeepScript = document.getElementById("inkeep-script");
 
    inkeepScript.addEventListener("load", () => {
      const inkeepWidget = Inkeep.ChatButton({
        baseSettings: {
          apiKey: "REPLACE_WITH_YOUR_INKEEP_API_KEY", // required - replace with your own API key
          primaryBrandColor: "#26D6FF", // your brand color, widget color scheme is derived from this
          organizationDisplayName: "Inkeep",
          // ...optional settings
        },
        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?",
          ],
        },
      });
    });
  };
 
  addInkeepWidget(); // initialize the 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 Chat Button documentation.

Zendesk Ticket CreationAdd Search Bar to Help Scout

On this page