Set up your status page

Updated · 3 min read

Your status page says at a glance whether your product works. At the top, one line: "All systems operational", or what is wrong. Below it, each part of your product with its state now and a bar for each of its last 90 days.

Add your components

A component is a part of your product people rely on: the website, sign-in, the API, email delivery.

  1. Open Components and choose Add a component.
  2. Type its Name. Its address on the page follows the name, so leave Address empty unless you want another.
  3. Add a Description if readers need a line to know what it is.
  4. Choose Add the component.

You never set a component's state by hand. It follows what is happening: an open incident puts it in Degraded, Partial outage or Major outage, a maintenance in progress puts it in Maintenance, and with nothing open it reads Operational.

Put them in groups

With many components, groups keep the page short, like "Platform" and "Apps". At the bottom of Components, type the group's name under New group and choose Add a group. To put a component in it, open the component and choose its Group, or use Add a component here in the group's menu.

The page shows groups and components in the order of the list. Drag one by its handle, or focus the handle, press Space and use the arrow keys. On the page each group folds into one line, and opens by itself when one of its components is not operational.

What readers get

  • The home: the line at the top, your components, any open incident with its latest update, and maintenance planned for the next seven days.
  • History: every incident and maintenance, by month, newest first.
  • A component's page: its state now, its uptime over 30 and 90 days, and each day something marked it.
  • Email: under Get the news by email, a reader types an address and confirms it, then chooses the components to follow, or follows everything. They are emailed when an incident is opened, updated or resolved, and when maintenance is scheduled. You find them under Integrations, then Subscribers.
  • Feeds: every incident and maintenance in RSS, Atom and JSON Feed, for the whole page or one component.

Uptime counts the minutes a component spent in an outage. Minutes in maintenance do not count against it.

Before you share the address

Open Settings and check the Site name, which readers see at the top and on the badge, and the Time zone, in which every time on the page is shown.

Related articles