Incidents

Configure incidents, manage their timeline and understand their effect on status.

Use incidents to tell visitors what went wrong and what you're doing about it. They appear as a timeline on the page; checks can also open and resolve them automatically. Incidents and their RSS/Atom feeds are enabled by default.

heyo-status.config.ts

incidents: { enabled: true },

Setting incidents.enabled: false makes /incidents, /incidents/:id, /rss.xml, /atom.xml and /admin/incidents/* return 404. No automatic incidents are opened, and the snapshot contains no active incidents.

Incident states and fields

An incident moves through investigating, identified, monitoring and resolved. These are timeline states, not an enforced sequence.

interface Incident {  id: string;  title: string;  status: "investigating" | "identified" | "monitoring" | "resolved";  severity: "minor" | "major" | "critical";  affectedMonitors: string[];  auto: boolean;  updates: IncidentUpdate[];  createdAt: Date;  updatedAt: Date;  resolvedAt: Date | null;}

statusIncidentStatusoptional

The four states form a timeline, not an enforced state machine. A new incident cannot be created as resolved.

severityIncidentSeverityoptional

critical drives the page to major-outage and triggers Slack mentionOnCritical.

affectedMonitorsstring[]optional

An empty array means the incident affects every monitor.

autobooleanoptional

True when monitoring opened the incident. Only automatic incidents are reconciled and automatically resolved.

updatesIncidentUpdate[]optional

Chronological entries with id, status, message, createdAt and an optional severity change.

Create and update an incident

Use the CLI locally (it talks to the database directly) or the admin API. The HTTP route requires adminToken in the configuration; keep the token out of version control.

heyo-status incident create --title "Elevated API latency" --severity major --monitors "API,Dashboard" --message "We are investigating elevated response times."heyo-status incident update inc_... --status monitoring --message "A fix is deployed."heyo-status incident resolve inc_... --message "Latency is back to normal."heyo-status incident list --status investigating

How an incident affects status

An active incident can change the page-wide status even if individual checks are passing. The page resolves status in this order:

An in-progress maintenance window → maintenance.
Any active critical incident → major-outage.
Any other active incident → degraded.
Otherwise monitors decide: all failing → major-outage, some failing → degraded, none → operational.

Active incidents appear in the snapshot with their full timeline, anchored at #incident-<id>. When incidents are enabled, RSS and Atom publish the newest 50 incidents at /api/heyo-status/rss.xml and /api/heyo-status/atom.xml. Feed entries link to the anchor using siteUrl (or the request origin) and include the timeline. See Badges, feeds and metrics.

Incident states and fields

Create and update an incident

How an incident affects status

Related