Skip to content

by Startups.Studio

Product Build and ship Issue Incident

Incident.update

PATCH /{namespace}/incidents/{id}

Changes the given properties of an Incident.

Noun: Incident
Mode: do
Event: Incident.updated

You, to your agent

Change the latest incident.

curl -X PATCH https://api.sb/ledgerlark.com/incidents/incident_1 \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"severity":"minor"}'

import { $ } from 'startup-builder'

const incident = await $.Incident.update({ id: 'incident_1', severity: 'minor' })

npx startup-builder do Incident.update --json '{"id":"incident_1","severity":"minor"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Incident.update({ id: 'incident_1', severity: 'minor' })"
  }
}

Update changes the given properties of an Incident. It is inherited: every Noun has get, list, create, update and delete.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Incident.
`by`	Worker		The Worker that performed it.
`for`	Party		The Party it was done on behalf of.
`via`	`string`		The Interface or request it arrived through.
`on`	`string`		The Action or Event that caused it, such as the failed attempt a retry follows.
`thing`	`string`		The record, at the Version the Action was decided against.
`input`	`json`		The input it was called with.
`createdAt`	`datetime`		When it was called.
`reserved`	`money`		The most this Action may cost, held against its Limits from the check until it settles, billed misses included.
`due`	`datetime`		When the Task is due.
`priority`	`integer`		Its rank in the inbox, highest first.
`recurrence`	`string`		The schedule a recurring duty repeats on.
`kind`	`string`		One of `bug`, `request`, or `question`.
`advisory`	`string`		For a vulnerability: the public advisory it matches, with the affected package and range.
`severity`	`string`		One of `minor`, `major`, or `critical`.
`detectedAt`	`datetime`		When monitoring or a Customer first reported it.
`resolvedAt`	`datetime`		When service was restored.
`personalData`	`boolean`		True when the Incident exposed personal data, which starts the breach-notice clock.

Outputs

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

Effects

Emits Incident.updated.
Two-way: try, send, do.

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.update

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.resolve

Previous Page

Mapping

Next Page