Inkeep light logo
Chat with usSee it for my content
IntegrationsZendeskHelp center

Add AI Chat to your Zendesk help center

What is Zendesk

Zendesk 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 and URL (optional) for the integration
  7. Click on Create
  8. Click the Example < /> button to get your API key and view suggested settings

Connect the script

  1. Click the Zendesk Products in the top bar, then select Guide
  2. Navigate to Guide Admin
  3. Click Customize on the theme you want to edit
  4. Click Edit code. Which will open theme code editor

In the templates section, find the document_head.hbs file and paste the code below:

<script id="inkeep-script" src="https://unpkg.com/@inkeep/uikit-js@0.3.19/dist/embed.js" type="module" defer></script>

Initialize the widget

Next, in the same file, 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().embed({
        componentType: "ChatButton",
        properties: {
          chatButtonType: "PILL",
          baseSettings: {
            apiKey: "INKEEP_API_KEY", // required
            integrationId: "INKEEP_INTEGRATION_ID", // required
            organizationId: "INKEEP_ORGANIZATION_ID", // 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
            botAvatarSrcUrl: "https://mydomain.com/mylogo", // use your own bot avatar
            quickQuestions: [
              "Example question 1?",
              "Example question 2?",
              "Example question 3?",
            ],
          },
        },
      });
    });
  };
 
  addInkeepWidget(); // initialize the widget
</script>

Save custom code

Click on the Publish. Navigate to your web application to make sure the widget is installed correctly.

For a full list of customizations, check out the Chat Button documentation.

Add AI Chat using Google Tag ManagerAdd AI Search to your Zendesk help center

On this page