Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APIProductBuild and shipIssueIncident

Incident routes: acknowledge, open, resolve

The Incident Verbs acknowledge, open, resolve as api.sb routes, with inputs, result, refusals and an example.

Reference for Incident, one group of Incident routes.

Incident.acknowledge

Acknowledge records that an on-call Worker owns an open Incident and stops its escalation. Verb page.

Text
POST /{namespace}/incidents/{incident}/acknowledge

Path: incident. Emits Incident.acknowledged.

Inputs

InputTypeRequiredDescription
incidentIncidentrequiredThe open Incident.

Returns

OutputTypeRequiredDescription
incidentIncidentrequiredThe acknowledged Incident.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/incidents/incident_2XOYkIEno0/acknowledge \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
JSON
{
  "api": "https://api.sb/leaseline.app",
  "incident": {
    "$id": "https://api.sb/leaseline.app/incidents/incident_2XOYkIEno0",
    "$type": "Incident",
    "status": "pending",
    "mode": "try",
    "severity": "minor",
    "detectedAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Incident.acknowledge",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Incident.open

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

Text
POST /{namespace}/incidents/open

Body, as JSON: the inputs. Emits Incident.opened.

Inputs

InputTypeRequiredDescription
severitystringrequiredsev1 stops Customers, sev2 degrades a core path, sev3 degrades one feature.
causestringrequiredThe Monitor, error group or Metric that tripped it.

Returns

OutputTypeRequiredDescription
incidentIncidentrequiredThe open Incident.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/incidents/open \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"severity":"sev1","cause":"Example cause"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "incident": {
    "$id": "https://api.sb/leaseline.app/incidents/incident_2XOYkIEno0",
    "$type": "Incident",
    "status": "pending",
    "mode": "try",
    "severity": "minor",
    "detectedAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Incident.open",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Incident.resolve

Resolve closes an Incident once its Monitors pass, posts the resolution to the status page and opens the review Task. Verb page.

Text
POST /{namespace}/incidents/{incident}/resolve

Path: incident. Body, as JSON: the other inputs. Emits Incident.resolved.

Inputs

InputTypeRequiredDescription
incidentIncidentrequiredThe Incident to close.
summarytextrequiredWhat failed and what fixed it.

Returns

OutputTypeRequiredDescription
incidentIncidentrequiredThe resolved Incident.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/incidents/incident_2XOYkIEno0/resolve \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"summary":"Example summary"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "incident": {
    "$id": "https://api.sb/leaseline.app/incidents/incident_2XOYkIEno0",
    "$type": "Incident",
    "status": "pending",
    "mode": "try",
    "severity": "minor",
    "detectedAt": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Incident.resolve",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

list, update, delete

Previous

Mapping

Next