Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.incident.io/llms.txt

Use this file to discover all available pages before exploring further.

​
The incident alert object

​
alert
object
required
Example:
{
  "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
  "created_at": "2021-08-17T13:28:57.801578Z",
  "deduplication_key": "4293868629",
  "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
  "id": "01GW2G3V0S59R238FAHPDS1R66",
  "resolved_at": "2021-08-17T14:28:57.801578Z",
  "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
  "status": "firing",
  "title": "*errors.withMessage: PG::Error failed to connect",
  "updated_at": "2021-08-17T13:28:57.801578Z"
}
​
id
string
required

The ID of this alert

Example:

"01GW2G3V0S59R238FAHPDS1R66"

​
incident
object
required

Incident slim is a subset of the full incident object, listing key fields.

Example:
{
  "external_id": 123,
  "id": "01FDAG4SAP5TYPT98WGR2N7W91",
  "name": "Our database is sad",
  "reference": "INC-123",
  "status_category": "triage",
  "summary": "Our database is really really sad, and we don't know why yet.",
  "visibility": "public"
}
​
alert_route_id
string

The ID of the alert route that created this incident alert

Example:

"01GW2G3V0S59R238FAHPDS1R67"