Incidents quickstart
By the end of this guide you’ll have created a manual incident, posted a couple of updates to it, acknowledged it from a responder’s perspective, and resolved it.
1. Create the incident
Section titled “1. Create the incident”-
Incidents → New incident.
-
Fill in:
- Title:
Investigating elevated 5xx errors on the API. - Severity:
major. - Initial message:
Several monitors reported failures starting around 14:30 UTC. We're investigating. - Affected monitors: select your
prod-apimonitor. Optional, but it drives the status-page banner.
- Title:
-
Click Create.
curl -X POST https://api.siteqwality.com/incident \ -H "Authorization: Bearer $SITEQWALITY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "title": "Investigating elevated 5xx errors on the API", "severity": "major", "message": "Several monitors reported failures starting around 14:30 UTC. We are investigating.", "affected_http_job_ids": ["a3c1f5e0-1234-4abc-9def-aaaaaaaaaaaa"] }'The response is the full incident object including the auto-attached first update. Save the id.
The incident lands at status: investigating, responder_status: triggered. The first update is automatically created with the message you provided.
2. Post an update
Section titled “2. Post an update”As you learn more, append updates. Each update is a (status, message) pair.
Open the incident, scroll to Updates, type a message, choose a status, post.
curl -X POST https://api.siteqwality.com/incident/$INCIDENT_ID/update \ -H "Authorization: Bearer $SITEQWALITY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "status": "identified", "message": "Cause identified: database connection pool exhaustion. Rolling out a fix." }'Posting an update with a new status advances the incident’s overall status. Don’t skip statuses. Go investigating → identified → monitoring → resolved.
3. Acknowledge
Section titled “3. Acknowledge”Acknowledging stops escalation. It says “I’ve got this; stop paging.” It does not resolve the incident.
Click the Acknowledge button on the incident.
curl -X POST https://api.siteqwality.com/incident/$INCIDENT_ID/acknowledge \ -H "Authorization: Bearer $SITEQWALITY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "acknowledged_by": "<your-user-uuid>" }'If acknowledged_by is omitted, the requesting user is recorded.
The responder_status flips to acknowledged. acknowledged_at and acknowledged_by are set. Escalation stops.
4. Resolve
Section titled “4. Resolve”When the underlying issue is fixed, resolve.
Either:
- Post an update with
status: resolvedand a closing message. This is the recommended path: it captures context. - Or click the Resolve button for a quick close with no message.
Recommended (with closing context):
curl -X POST https://api.siteqwality.com/incident/$INCIDENT_ID/update \ -H "Authorization: Bearer $SITEQWALITY_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "status": "resolved", "message": "Connection pool size increased; error rate back to baseline." }'Or quick resolve:
curl -X POST https://api.siteqwality.com/incident/$INCIDENT_ID/resolve \ -H "Authorization: Bearer $SITEQWALITY_API_KEY"Both paths set status: resolved, responder_status: resolved, and resolved_at.