Show your status on your site

Updated · 2 min read

Your status can show where your customers already are: a small frame in your product, a badge in a README or a footer, or your own code reading it.

A frame in your product

The frame shows the line at the top of your status page, the components that are not operational, any open incident with its latest update, and a link to the full page.

  1. Open Settings, then Embedding.
  2. Tick Let other sites show your status and save.
  3. To keep it to your own sites, list them under Only on these sites, one address per line, like app.example.com or *.example.com. Left empty, any site can show it.
  4. Under The code, choose Copy code and paste it into your product's page.

To show only some components, tick them under Only these components and choose Update the code. Paste a different code on each page that needs its own.

A badge

The badge is a small image of your status now: "All systems operational", or the worst state of the moment. It works everywhere, even with the frame turned off. Under The badge on the same tab, copy the code in Markdown for a README, or in HTML for a page:

[![Orbit](https://status.example.com/badge.svg)](https://status.example.com/)

Add ?component= and a component's address for that component alone, like /badge.svg?component=api.

Your own code

https://status.example.com/api/v1/status answers anyone, from any site, with your status in JSON: the line at the top, every component's state, the open incidents, and the maintenance in progress and coming up. It follows every change you make and names nobody on your team.

Related articles