Introduction

Heyo Status is a status page you own. It monitors services on a schedule, stores uptime history, publishes incident timelines and maintenance windows, notifies your team and your subscribers, and renders a server-side status page in React Router, Next.js or Astro. One configuration file describes all of it; the CLI, the HTTP API, the scheduler and the UI read the same object.

What it does

The shape of a project

Three files make a status page. A configuration, a catch-all API route, and a page that renders a snapshot:

import { heyoStatus } from "@heyo-sh/heyo-status/config";import { sqlite } from "@heyo-sh/heyo-status/db";export const statusPage = heyoStatus({  database: sqlite("status.sqlite"),  title: "Acme Status",  theme: "slate",  monitors: [{ name: "Website", type: "http", url: "https://acme.com" }],  adminToken: process.env.HEYO_STATUS_API_TOKEN,});export default statusPage;

import { statusHandler } from "@heyo-sh/heyo-status/next";import { statusPage } from "../../../../heyo-status.config";export const { GET, POST, PATCH, PUT, DELETE } = statusHandler(statusPage);

import { StatusPage } from "@heyo-sh/heyo-status/ui";import { statusPage } from "../heyo-status.config";export default async function Page() {  const snapshot = await statusPage.api.getSnapshot();  return <StatusPage snapshot={snapshot} theme={statusPage.theme} />;}

Everything else — the CLI, the scheduler, badges, feeds, notifications — is derived from the same statusPage object.

Design decisions worth knowing up front

• The runtime is framework-neutral. The HTTP surface is a single Hono app behind statusPage.handler(request). The framework adapters are thin: they hand a Request over and return a Response.
• Persistence is an interface. Core code only ever talks to StatusDatabaseAdapter. SQLite, D1 and PostgreSQL are implementations of it, and so is anything you write yourself.
• Writes are closed by default. /admin/* refuses every request until an admin token is configured. Public subscriptions are disabled by default, and visitor-supplied webhooks need an extra opt-in.
• The page renders on the server. Incident disclosures and monitor groups are native <details> elements, because a status page has to stay readable exactly when the JavaScript bundle does not load.

Runtime requirements

Start here