API status with Statusboard
The page is set up for a public API: the REST endpoint, webhooks and docs as separate components. Point each one at a health URL and developers can check the page before they open a ticket.
- Replace the example URLs with a health endpoint for each service.
- Make the health endpoint return 200 only when the service and its database respond.
- Save and share the page in your API docs and error messages.
- Post an incident for problems a health check cannot see, such as delayed webhooks.
What to know
Developers integrating your API check a status page before they debug their own code. Without one, a ten-minute outage turns into dozens of support emails and a lot of time spent reproducing problems that were never on their side.
A health check is only as useful as the endpoint behind it. Return 200 when the service can reach its database and dependencies, and an error when it cannot. Avoid pointing the check at a static page, which stays up while the API is down.
Some failures are invisible to an HTTP check: delayed webhook deliveries, a slow queue, a partial outage in one region. Use incidents for those, with an impact level and updates as you go. The overall banner reflects both the checks and the open incidents.
Updated · Cosmovex
Questions
What counts as down?
A request that fails, times out after 10 seconds or returns a status code of 400 or above.
Can I check a private endpoint?
No. Checks come from the public internet, and private or internal addresses are refused.
Can I send custom headers?
Not at the moment. Use a public health URL that needs no authentication.
Is Statusboard free?
Yes: one page with 3 components, checks every 5 minutes, incidents and 30 days of uptime bars, with a small "Powered by Statusboard" footer. Pro is $9 a month for 5 pages, 25 components, 90 days of history, no footer and email alerts.
The free plan covers everything on this page. Statusboard Pro ($9/mo, billed monthly) is described on the Statusboard page.
