Installation

Install your HelpKite widget in two ways: for all website visitors or with user authentication for logged-in users.

For All Website Visitors

Basic Installation

For anonymous visitors and non-logged in users

HTML
<script type="text/javascript">
  window.helpkiteSettings = {
    agentId: 'your-agent-id',
  };
</script>
<script type="text/javascript" src="https://embed.helpkite.com/sdk"></script>

Place this code before the closing </body> tag on every page where you want the widget to appear.

For Authenticated Users

Identity Verification

Secure authentication for logged-in users

Frontend Script

HTML
<script type="text/javascript">
  window.helpkiteSettings = {
    agentId: 'your-agent-id',
    user_id: 'user_123',
    user_hash: 'generated_hmac_hash', // Generated on your server
    user_metadata: {
      name: 'John Doe',
      email: 'john@example.com',
      company: 'Acme Corp',
      plan: 'premium'
    }
  };
</script>
<script type="text/javascript" src="https://embed.helpkite.com/sdk"></script>
  • • Replace user_id with your user's unique identifier
  • • Generate user_hash on your server using the code below
  • • Add any user data to user_metadata

Server-side Hash Generation

Node.js
const crypto = require('crypto');

const secret = 'your-hmac-secret'; // Your verification secret key  
const userId = current_user.id; // Your user's unique identifier

const user_hash = crypto.createHmac('sha256', secret).update(userId).digest('hex');

Generate this hash on your server for each logged-in user and include it in the frontend script.

Get Your HMAC Secret

You need your organization's HMAC secret key to generate user hashes. Find this in your agent's install section in the dashboard.

Go to Dashboard

Widget Installed!

Your HelpKite widget is now live on your website.

Set up Knowledge BaseMonitor Conversations