HelpDocs

Show your latest system status to users right inside your HelpDocs knowledge base. A simple status badge in the navigation reflects your current service health.

What it does

The HelpDocs integration displays a status badge in your knowledge base navigation that shows:

• Current system status: All systems operational, partial outage, major outage, or ongoing maintenance
• Real-time updates: Badge updates automatically when your status page changes
• Direct link: Users can click the badge to view your full status page
• Seamless integration: Appears natively in your HelpDocs navigation bar

Setup and Configuration

The HelpDocs integration is primarily configured on the HelpDocs side. For detailed setup instructions, please refer to the official HelpDocs documentation:

On Hyperping

On the Hyperping side, you just need to ensure you have a status page set up:

1. Open Status Pages

   Go to Status Pages in your Hyperping dashboard.

2. Create a status page

   Create a status page if you haven't already.

3. Copy the status page URL

   Copy the status page URL (e.g., status.yourcompany.com).

4. Use it in HelpDocs

   Use this URL in the HelpDocs configuration.

Use Cases

• Support transparency: Let users see system status while browsing your help docs
• Reduce support tickets: Users can quickly check if issues are on your end
• Build trust: Show transparency about service health directly in your help center
• Unified experience: Keep users informed without leaving your documentation

Testing your setup

Next steps