Inkeep light logo
Schedule a callSee it for my content
IntegrationsHelpscout

Add AI Chat to your Help Scout help center

What is Help Scout

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

Get an API key

  1. Go to the Inkeep Dashboard
  2. Select your project under Projects
  3. Go to the Integrations tab
  4. Click on Create integration
  5. Select Web
  6. Provide a Name.
  7. Specify a URL for where this integration will be used.
  8. For production API keys, leave Enforce referrer URL checked.
  9. Click on Create
  10. Click the Example < /> button to get your API key and view suggested settings

For local or staging API keys, see here.

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: "INKEEP_API_KEY", // required
          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.

Embedded ChatAdd AI Search to your Help Scout help center

On this page