Skip to content

by Startups.Studio

Product Build and ship Issue Incident

Incident.open

POST /{namespace}/incidents/open

Open starts an Incident from a failing Monitor, an error spike or a Metric past its threshold, and pages the on-call Worker.

Noun: Incident
Mode: do
Event: Incident.opened

You, to your agent

Open the latest incident.

curl -X POST https://api.sb/quietcopy.com/incidents/open \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"severity":"sev1","cause":"Example cause"}'

import { $ } from 'startup-builder'

const incident = await $.Incident.open({ severity: 'sev1', cause: 'Example cause' })

npx startup-builder do Incident.open --json '{"severity":"sev1","cause":"Example cause"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.open({ severity: 'sev1', cause: 'Example cause' })"
  }
}

Inputs

Input	Type	Required	Description
`severity`	`string`	required	`sev1` stops Customers, `sev2` degrades a core path, `sev3` degrades one feature.
`cause`	`string`	required	The Monitor, error group or Metric that tripped it.

Outputs

Output	Type	Required	Description
`incident`	Incident	required	The open Incident.

Effects

Emits Incident.opened.
Performed by the Reliability Engineer.
Two-way: it runs at once, in the try, send and do modes.
Pages the on-call Worker, agent first, and a Human after five minutes unacknowledged.
Never holds a rollback or a guardrail stop.
Posts sev1 and sev2 Incidents to the status page.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Incident.open

When it waits

Gate	Default
Decision class	Low: two-way, nothing at stake
Delay window	None: it runs once review passes.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Incident.list

Previous Page

Incident.resolve

Next Page