API keys are your gateway to connecting HelpDocs with external applications and services. They provide secure, programmatic access to your Knowledge Base content and allow you to build powerful integrations.
Let's explore how to create and manage API keys.
What Are API Keys?
API keys are unique tokens that authenticate requests to the HelpDocs API. They act like digital keys that unlock specific parts of your Knowledge Base for external applications.
With API keys, you can:
- Search and retrieve articles programmatically
- Sync content with other platforms
- Power chatbots with your Knowledge Base content
- Build custom integrations for your workflow
- Export data for analysis or backup purposes
Creating Your First API Key
Getting started with API keys is straightforward. Here's how to create one:
- Head to Settings > API
- Click Create key
- Your new key opens in the Edit API key panel, with the current date and time in its name and Read access only
- Copy your key from the Key field, give it a Name, and click Save changes
Editing API Keys
Once you've created an API key, you can customize its settings to fit your specific needs:
- Head to Settings > API
- Find your key and click the ⋯ menu > Edit
In the edit interface, you can modify:
- Name: Give your key a descriptive name like "Chatbot Integration" or "Data Export Tool"
- Permissions: Check Read, Write, or both (Write access depends on your plan)
- Permission groups: Choose which restricted articles the key can read. A key with no groups can only read articles that aren't restricted to a group (Permission Groups depend on your plan)
Understanding Permissions
- Read Access: Allows retrieving articles, categories, and other content. Perfect for search integrations and content syndication.
- Write Access: Enables creating, updating, and deleting content through the API. Ideal for content management integrations and automated workflows. If the integration also needs to read content, check Read too.
Removing API Keys
When you no longer need a key, click its ⋯ menu > Remove, then Confirm Remove. Anything still using that key stops working.
Admins and the Owner can remove any key on the account, including one created by someone else (like a colleague who has left). Another person's key stays masked, so you can't see its full value, but the Remove key option is still available. Editing someone else's key isn't available.
Best Practices and Security Tips
Follow these guidelines to keep your API keys secure and effective:
- Use descriptive names: Name your keys based on their purpose, like "Slack Bot" or "Analytics Dashboard"
- Apply least privilege: Only grant the minimum permissions needed for each integration
- Rotate keys regularly: Create new keys periodically and remove old ones
- Keep them server-side: Never expose API keys in frontend code or browser applications
- Monitor usage: Regularly review your active keys and remove unused ones
Creative Ways to Use Your API Keys
Here are some ideas for putting your API keys to work:
💬 Customer Support Integration
Connect your Knowledge Base to your support platform. Agents can search articles without leaving their workflow, making customer interactions faster and more accurate.
🤖 Chatbot Power-Up
Use the Chatbot Source Page with your API key to automatically feed your latest content to AI assistants. Your chatbot stays current without manual updates.
🔄 Content Synchronization
Keep multiple platforms in sync by automatically pushing updates from HelpDocs to your app, website, or other documentation tools.
📊 Analytics and Reporting
Extract data about your articles, categories, and content performance to build custom dashboards and gain deeper insights into your Knowledge Base usage.
🌊 Automated Workflows
Trigger actions in other tools when articles are published or updated. Create sophisticated automation that keeps your entire tech stack connected.
Ready to start building? Check out our API documentation for detailed endpoints, examples, and implementation guides that'll help you make the most of your new API keys ✨