Incidents quickstart
Create a manual incident, post an update, acknowledge it and resolve it.
1. Create the incident
Section titled “1. Create the incident”-
Go to Respond → Incidents and click Report incident.
-
Fill in:
- Title:
Investigating elevated 5xx errors on the API. - Severity: Major.
- Service: optional. A service brings its escalation policy with it.
- Initial message:
Several monitors reported failures starting around 14:30 UTC. We're investigating.
- Title:
-
Click Report incident. The incident opens.
With an API key exported as SITEQWALITY_API_KEY:
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." }'Export the id from the response as INCIDENT_ID; the next steps use it.
The incident opens at status: investigating, responder_status: triggered, with your message as its first update.
2. Post an update
Section titled “2. Post an update”Open the incident. Under Post an update, choose Public update, pick the new status (here Identified), type the message and click Post update.
The composer starts on Internal note, which stays with your team and never changes the status.
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." }'An update with a new status advances the incident: investigating → identified → monitoring → resolved.
3. Acknowledge
Section titled “3. Acknowledge”Acknowledging records that someone owns the incident and stops any escalation. It does not resolve the incident.
Click the Acknowledge button on the incident.
An API key acknowledges on behalf of a user: acknowledged_by takes your user ID, which GET /account/info lists.
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>" }'responder_status flips to acknowledged.
4. Resolve
Section titled “4. Resolve”Post a Public update with the status Resolved and a closing message, or click Resolve to close it without one.
With a closing message:
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." }'Without one:
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.