Embedded Chat

What is Zendesk

Zendesk is a customer service solution for handling support tickets.

Get an API key

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

For local or staging API keys, see here.

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://unpkg.com/@inkeep/cxkit-js@^0.5.36/dist/embed.js"
  defer
></script>

Creating a custom page

Click on Add
Click on Custom page
Specify a name for the custom page - ask-ai
Click on Add custom page
Add the code below to a new file (ask_ai.hbs):

ask_ai.hbs

<div class="container">
  <div class="category-container">
    <div class="category-content">
      <header class="page-header">
        <h1>Ask AI ✨</h1>
      </header>
      <div id="main-content" class="section-tree">
        <div id="inkeepEmbeddedChat"></div>
      </div>
    </div>
  </div>
</div>

Custom CSS (optional)

Zendesk allows you to add a custom css file to the assets directory:

Create an inkeep-styles.css stylesheet and paste in the below:

inkeep-styles.css

[data-theme="light"] .ikp-search-bar__button {
  background: white;
  border-radius: 6px;
  width: 100%;
}

In the theme code editor, click Add
Click on Asset
Upload the created css file

Next, go back to the header.hbs file and add the following code at the end of the file:

<script type="text/javascript" defer>
  const inkeepScript = document.getElementById("inkeep-script");
 
  // configure and initialize the widget
  const inkeepStyles = "{{asset 'inkeep-styles.css'}}"; // <--- replace with provide template string (if different)
  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: {
        styles: [
          {
            key: "main",
            type: "link",
            value: inkeepStyles,
          },
        ],
      },
    },
    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) {
      const chatContainer = document.getElementById("inkeepEmbeddedChat");
      chatContainer && Inkeep.EmbeddedChat("#inkeepEmbeddedChat", config); // initialize the EmbeddedChat 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 Embedded Chat documentation.