The Scrums.com API is planned and not yet publicly available. Endpoints and behaviour are subject to change before release.
Overview
Incidents represent events on the platform that require a response — SLA breaches, infrastructure failures, delivery blockers, agent errors, and compliance violations. Alerts are the detection layer: they monitor signals across Service Lines and trigger incident creation or notifications when thresholds are crossed.
Incidents are not the same as tasks or risks. A risk is a forward-looking signal on the Observability API. An incident is a live event requiring active resolution.
Core Concepts
Incident types
Incident severity
Alerts
An alert is a rule that watches a metric or signal and fires an incident or sends a notification when a threshold is met. Alerts are configured per workspace or per Service Line.
Endpoints
GET /v1/incidents
List incidents for an organization or workspace.
Request
Response
POST /v1/incidents
Create an incident manually. The platform also creates incidents automatically from alert rules.
Request
Response
Returns the created incident with status: "open".
GET /v1/incidents/
Retrieve an incident with full detail and timeline.
Response
PATCH /v1/incidents/
Update an incident — reassign, escalate severity, add notes, or resolve.
Request
GET /v1/alerts
List alert rules for a workspace.
Response
POST /v1/alerts
Create a new alert rule.
Request
Notes
- Alert conditions reference metrics from the Observability API.
- Alerts fire at most once per
window_minutes to prevent notification floods.
- Multiple actions per alert are supported; all fire simultaneously when the condition is met.
Objects
Incident
Best Practices
- Wire critical Service Lines to P1/P2 alert rules at activation. Do not wait for an incident to discover that you have no alerting. Create alert rules when you create the Service Line.
- Use incidents as the authoritative resolution record. When something goes wrong with a managed or ODS Service Line, the incident record is the audit trail. Resolution notes should be factual, not CYA prose.
- Distinguish delivery blockers from infrastructure failures. They have different owners and different escalation paths. Miscategorizing an incident slows resolution.