Share service health with website and API status badges

Put a service health indicator where users need it

A status badge gives visitors a quick visual signal about a monitored service without requiring them to search for a status page. Add it to documentation, a support page, a product dashboard, or another place users already look when they have questions about availability.

Choose a location that is easy to find and label the service clearly. If your product has separate website, API, and background services, make sure the badge points to the status users need rather than implying that one component represents the entire platform.

Use badges alongside clear status updates

A badge is a compact indicator, not an explanation of an outage. Link it to a hosted status page where customers can read incident details, maintenance notices, and recovery updates. This helps keep the badge simple while giving people a place to find context.

Before publishing, confirm that the monitored service names make sense to customers and that the status page explains what each service includes. Review the badge after product changes so it does not point to a retired service or an outdated customer help page.

Start with reliable monitoring coverage

Status badges display the health signal your monitoring setup provides. Keep that signal useful by covering the important user-facing endpoints with website monitoring and API monitoring. Review current badge and monitoring availability on the pricing page.

When an incident occurs, share verified information and update it as the situation changes. A visible status indicator works best when it is supported by accurate checks and timely communication.