Skip to content
Navigation
POST/status/incidents

Create a status incident or maintenance window

Publishes an incident/maintenance window and (by default) notifies subscribers

Request body

FieldTypeDescription
kindrequired"incident" | "maintenance"
titlerequiredstring
statusrequired"investigating" | "identified" | "monitoring" | "resolved" | "scheduled" | "in_progress" | "verifying" | "completed"Incident lifecycle (investigating|identified|monitoring|resolved) or maintenance lifecycle (scheduled|in_progress|verifying|completed), depending on `kind`.
impact"none" | "minor" | "major" | "critical" | "maintenance"Incident impact severity
impactOverrideboolean
affectedComponentsrequiredobject[]
bodyrequiredstringBody of the first status update
scheduledStartAtstring | null
scheduledEndAtstring | null
autoStartboolean
autoCompleteboolean
backfillobjectCreates the incident already resolved, historical; never notifies
notifySubscribersboolean

Response

Status incident created

FieldTypeDescription
idrequiredstringTypeID - a type-prefixed UUID
kindrequired"incident" | "maintenance"
titlerequiredstring
statusrequired"investigating" | "identified" | "monitoring" | "resolved" | "scheduled" | "in_progress" | "verifying" | "completed"Incident lifecycle (investigating|identified|monitoring|resolved) or maintenance lifecycle (scheduled|in_progress|verifying|completed), depending on `kind`.
impactrequired"none" | "minor" | "major" | "critical" | "maintenance"Incident impact severity
impactOverriderequiredboolean
scheduledStartAtrequiredstring | nullISO 8601 timestamp or null
scheduledEndAtrequiredstring | nullISO 8601 timestamp or null
autoStartrequiredboolean
autoCompleterequiredboolean
startedAtrequiredstringISO 8601 timestamp
resolvedAtrequiredstring | nullISO 8601 timestamp or null
backfilledrequiredboolean
notifiedAtrequiredstring | nullISO 8601 timestamp or null
createdByrequiredstring | null
createdAtrequiredstringISO 8601 timestamp
updatedAtrequiredstringISO 8601 timestamp
affectedComponentsrequiredobject[]
updatesrequiredobject[]

Errors

400Validation error
401Unauthorized

Example request

curl \
  -X POST \
  "https://feedback.quackback.io/api/v1/status/incidents" \
  -H "Authorization: Bearer qb_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
  "kind": "example_kind",
  "title": "example_title",
  "status": "example_status",
  "impact": "example_impact",
  "impactOverride": false,
  "affectedComponents": [],
  "body": "example_body",
  "autoStart": false,
  "autoComplete": false,
  "notifySubscribers": false
}'