Supported platforms
Mintlify integrates with the following support platforms:Intercom
In-app messaging and customer support
Front
Collaborative inbox and live chat
Intercom
Add an Intercom messenger widget to your documentation for live chat and customer support.Configuration
Add the following to yourdocs.json file:
docs.json
Getting your App ID
Log in to Intercom
Go to your Intercom dashboard.
Copy your App ID
Your App ID appears in the installation code. It looks like
abc123def4.Copy just the App ID (not the entire installation code).Features
When configured, Intercom provides:- Live chat - Real-time messaging with your support team
- Help center - Access to articles and FAQs within the messenger
- Product tours - Guide users through features
- Custom bots - Automated responses to common questions
- User tracking - See which pages users visit before contacting support
Example
docs.json
Front
Add a Front Chat widget to enable customer conversations through a collaborative inbox.Configuration
Add the following to yourdocs.json file:
docs.json
Note the different structure - Front Chat uses a direct string value instead of an object.
Getting your Chat ID
Log in to Front
Go to your Front dashboard.
Get Chat ID
Find your chat widget and copy the Chat ID. It looks like a long hexadecimal string:
1365d046d7c023e9b030ce90d02d093a.Features
Front Chat provides:- Live chat - Real-time conversations with your team
- Team collaboration - Multiple team members can respond
- Conversation history - Full context of previous interactions
- CRM integration - Connect with your existing tools
- Custom branding - Match your documentation design
Example
docs.json
Widget behavior
Support widgets typically:- Appear as a floating button in the bottom-right corner
- Open a chat window when clicked
- Display unread message counts
- Allow users to continue conversations across sessions
- Work on all documentation pages
Widget positioning
Both Intercom and Front Chat widgets:- Float above page content
- Don’t interfere with navigation or reading
- Collapse automatically when not in use
- Maintain position when scrolling
Combining support integrations
You can use multiple support integrations together:docs.json
Combining with analytics
Support integrations work alongside analytics platforms:docs.json
- Track when users open chat
- Correlate support requests with page views
- Identify which pages generate the most support questions
- Measure documentation effectiveness
Best practices
Set up automated responses
Set up automated responses
- Configure chatbots for common questions
- Link to relevant documentation pages in responses
- Set expectations for response times
- Provide self-service options before live chat
Monitor support metrics
Monitor support metrics
- Track which pages generate the most support requests
- Identify documentation gaps from common questions
- Measure response times and user satisfaction
- Use insights to improve documentation
Customize widget appearance
Customize widget appearance
- Match widget colors to your brand
- Customize welcome messages
- Set appropriate online/offline status
- Use friendly, helpful language
Train your team
Train your team
- Ensure team members understand your product
- Create response templates for common questions
- Link to specific documentation sections in responses
- Escalate technical issues appropriately
Use cases
Developer documentation
- Answer technical questions in real-time
- Help developers troubleshoot integration issues
- Provide code examples and guidance
- Collect feedback on API design
Product documentation
- Guide users through complex workflows
- Clarify feature capabilities
- Assist with account setup
- Handle billing and subscription questions
Internal documentation
- Support internal teams with processes
- Answer HR and policy questions
- Provide IT support
- Facilitate knowledge sharing
Privacy considerations
Privacy best practices
- Add cookie consent banners
- Update your privacy policy to mention support integrations
- Allow users to opt out of tracking
- Delete user data upon request
- Anonymize conversation logs when appropriate
Troubleshooting
Widget not appearing
Widget not appearing
- Verify your App ID or Chat ID is correct
- Check that the integration is properly formatted in
docs.json - Clear your browser cache and reload the page
- Ensure no ad blockers are blocking the widget
- Check browser console for JavaScript errors
Widget appears but doesn't work
Widget appears but doesn't work
- Verify your support platform account is active
- Check that the widget is enabled in your platform settings
- Ensure team members are set to “online” status
- Test with a different browser or device
Widget positioning issues
Widget positioning issues
- Check for CSS conflicts with custom styles
- Verify z-index values don’t hide the widget
- Test on different screen sizes
- Contact the support platform about customization options
Messages not reaching team
Messages not reaching team
- Verify team member email notifications are enabled
- Check spam folders for notification emails
- Ensure correct team members have access
- Review routing rules in your platform settings
Next steps
Analytics Integrations
Add analytics to track documentation usage
Intercom Docs
Learn more about Intercom features
Front Docs
Explore Front Chat capabilities
Quickstart
Return to documentation setup guide