Add Chat Button to Zendesk Help Center

What is Zendesk

Zendesk is a customer service solution for handling support tickets.

Get an API key

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

Connect the script

Click the Zendesk Products in the top bar, then select Guide
Navigate to Guide Admin
Click Customize on the theme you want to edit
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"
  type="module"
  src="https://cdn.jsdelivr.net/npm/@inkeep/cxkit-js@0.5/dist/embed.js"
  defer
></script>

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.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 Publish button. 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.

Positioning

We support customization of styles via custom css in baseSettings, you can style "Ask AI" button by targetting it's class as so:

const baseSettings = {
  theme: {
    //...Other base Settings

    // Custom styles injection
    styles: [
      {
        key: "custom-theme",
        type: "style",
        value: `
         .ikp-chat-button__container {
           // Position the Ask-AI button on the left
           left: 1.5rem;
         }
       `,
      },
    ],
  },
};

You can find more information in the Custom Styles documentation.