Product Guide

ReadMe Documentation

Welcome to the ReadMe Documentation, where you'll find comprehensive guides and community support to help you start working with ReadMe as quickly as possible!

Get Started

Health Check

Communicate real-time status to your users

It's important to let your users know when your API or product is having stability issues or downtime. ReadMe allows you to show a notification to your users if that's the case. This can be accessed in your dash by going to General Settings > Health Check.

There are two different types of health check that we currently support:

1. Manual Update

You manually tell us whether your API is healthy or not, optionally providing a status URL which we'll link to your users to get further details. You let your users know of your API status by logging into your ReadMe account and updating the toggle.

Screenshot showing manual health check provider.

2. Statuspage.io Sync

If you already have a status page setup at https://www.statuspage.io/, you can select this and give us your "page ID." You can grab your page ID from the URL when you're administering your status page. It is the part at the end of the URL: https://manage.statuspage.io/pages/xxxxxxxxxxxx

Once you give us that, we'll periodically check Statuspage's API to make sure your page isn't reporting any issues.

Screenshot showing statuspage.io health check provider.

What it Looks Like On the Hub

We display an alert to your issues when we detect that your API is having issues. If you provided us with a URL (for manual) we link to it. If you're using statuspage.io, we automatically fetch your URL from the API.

Screenshot showing unhealthy alert on the front end.

Updated about a month ago


Health Check


Communicate real-time status to your users

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.