Chatbot

Integrate Chatbot

Overview

Embed a knowledge assistant into your application, with configurable workflows to drive customers to sales, request features, while minimizing repetitive support burden.

Configure Experience

Chatbot settings

To enable the chatbot through the application, follow these steps to configure its settings.

First, access the Publish guide by clicking the publish icon in the top right corner, which looks like an arrow pointing up. From there, navigate to the Chatbot tab in the publish module.

You will see a series of fields that you need to configure.

Setting	Description
Enable Chatbot	Activates the chatbot.
Display on Docs	Makes the chatbot visible on your documentation pages.
Support Email	Email address to handle support inquiries.
Avatar	Choose an avatar for your knowledge assistant in the chat interface.
Agent Name	Name that appears at the top of the chat interface when the chatbot is triggered.
Button Label	Label for the button that launches the chatbot, such as 'Ask AI' or 'Help'.
First Message	Default message that appears when the chatbot is triggered for the first time.
Allowed Domains	List of domains permitted to host the chatbot.

Make sure all settings meet your requirements before proceeding. This ensures the chatbot functions as intended.

Enable On Docs

Click the Publish icon in top right, and then click the Chatbot tab
Fill in the necessary fields such as support email, avatar, agent name, button label, first message, and allowed domains.
Enable the chatbot and choose whether to display it on DocsHound.
Click Save to save your settings.

To publish the chatbot after configuring your settings, first, ensure you are on the publish guide page. Locate the publish icon in the top right corner; it's the one with the arrow pointing up.

Once on the publish modal page, go to the chatbot tab. Here you will review your configured settings. If everything looks good, click save to initiate the creation of your chatbot based on the current documentation.

It's important to wait until the save operation is fully completed. Avoid exiting the page immediately after clicking save, as this might interrupt the process.

Wait for Save to Complete

Ensure you allow the entire save process to finish before exiting. Interrupting it may prevent your changes from being saved.

After the save operation is completed, go back to the theme tab and click publish. If you enabled the chatbot for your docs page, you should now see the chat button on the bottom right of your page with all your configured settings.

Note that every time you update your documentation and click publish, the chatbot will pull in the latest content automatically.

Integrate to App & Site

Add to Application and Marketing Site

To embed the DocsHound chatbot directly into your application, follow these steps:

Enable the chatbot in the publish dialog.
Add the name of your domain to the allowed domains list at the bottom of the Chatbot configuration in the publish modal.
Click save.

After saving the Chatbot settings, reopen the publish dialog and go to the status tab. You will see a dedicated HTML snippet. Copy and paste this snippet into the main HTML tag of your webpage or app, right before the closing body tag.

html

<html>
  <head>
  ...
  </head>

  <body>
  ...

  <!-- Docshound Chatbot -->
  <script
    type="text/javascript"
    async
    defer
    src="https://YOUR_CUSTOM_URL/-/chat.js"></script>
  <docshound-chat></docshound-chat>

  </body>

</html>

If you have any specific configurations or requirements, reach out to your DocsHound point of contact, who will be able to address promptly.

Frequently Asked Questions

How do I enable the chatbot?
If you are on the Pro Plan with the chatbot upgrade, you can enable the chatbot on your documentation site or within your application. For the documentation site, go to the publish guide icon and select the chatbot tab. Toggle the enable chatbot option and follow the setup instructions.
How do I update the chatbot settings?
To update chatbot settings, go to the publish guide icon and select the chatbot tab. Here, you can configure settings like support email, avatar, agent name, button label, first message, and allowed domains. Save your changes to apply them.
Is custom setup support available for the chatbot?
Yes, for custom chatbot setups within your application, please reach out to your DocsHound point of contact. They will assist you in configuring the chatbot according to your specific requirements.
Can I control where the chatbot is visible?
Yes, you can control where the chatbot is visible. In the chatbot tab, you can toggle options like enable chatbot and display on docs to specify whether the chatbot should appear on your documentation site or within your application.