Installing the InsightEmbed Widget
This guide will walk you through the process of installing the InsightEmbed widget on your website. The widget is designed to be lightweight and compatible with virtually any website, regardless of the technology stack you're using.
Prerequisites
Before you begin, make sure you have:
- An active InsightEmbed account
- Access to edit your website's HTML
- Your unique API key (available in your dashboard)
Installation Steps
Step 1: Get Your Widget Code
- Log in to your InsightEmbed dashboard at app.insightembed.com
- Navigate to the "Widget" section
- Click on "Installation"
- You'll see a code snippet that looks like this:
html
<script src="https://cdn.insightembed.com/widget.js" data-api-key="YOUR_API_KEY" data-domain="yourdomain.com"></script>Step 2: Add the Widget to Your Website
- Copy the widget code from your dashboard
- Paste it into your website's HTML, just before the closing
</body>tag - Replace
YOUR_API_KEYwith your actual API key if it's not already populated - Replace
yourdomain.comwith your actual domain name
Example Implementation
html
<!DOCTYPE html>
<html>
<head>
<title>My Website</title>
<!-- Your existing head content -->
</head>
<body>
<!-- Your website content -->
<!-- InsightEmbed Widget (place just before closing body tag) -->
<script src="https://cdn.insightembed.com/widget.js" data-api-key="abc123xyz456" data-domain="example.com"></script>
</body>
</html>Verifying Installation
After adding the widget to your website:
- Visit your website in a browser
- You should see the InsightEmbed icon in the bottom-right corner of the page
- Click on the icon to open the widget
- Try selecting some text to analyze it
If the widget doesn't appear, check the following:
- Ensure your API key is correct
- Verify that your domain is properly registered in your InsightEmbed dashboard
- Check your browser console for any error messages
Next Steps
Now that you've installed the widget, you can:
Troubleshooting
If you encounter any issues during installation, please refer to our Common Errors guide or contact our support team at support@insightembed.com.