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.

Read your alerts in incident.io. Alerts are events ingested from third parties by alert sources. They can trigger incidents and escalations, as configured in alert routes. To view your alerts, you can list all alerts, or show a single alert. If you’d like to view only alerts that are currently firing, you can filter by status. To view the alert that was created for an event in your external system, filter by deduplication key. If you’d like to view alerts connected to a particular incident, you can list incident alerts. You can filter by incident_id to find all alerts attached to a particular incident, or by alert_id to find the incident that a particular alert triggered.

​
The alert object

​
alert_source_id
string
required

The ID of the alert source this alert fired on

Example:

"01GW2G3V0S59R238FAHPDS1R66"

​
attributes
object[]
required

Attribute values parsed from the alerts payload

Example:
[
  {
    "array_value": [
      {
        "catalog_entry": {
          "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "name": "Primary On-call"
        },
        "label": "Payments Team",
        "literal": "SEV123"
      }
    ],
    "attribute": {
      "array": false,
      "emoji": "fire",
      "id": "01GW2G3V0S59R238FAHPDS1R66",
      "name": "service",
      "required": false,
      "type": "CatalogEntry[\"01GW2G3V0S59R238FAHPDS1R67\"]"
    },
    "value": {
      "catalog_entry": {
        "catalog_type_id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Primary On-call"
      },
      "label": "Payments Team",
      "literal": "SEV123"
    }
  }
]
​
created_at
string<date-time>
required

When this entry was created

Example:

"2021-08-17T13:28:57.801578Z"

​
deduplication_key
string
required

A deduplication key which uniquely references this alert from your alert source. For newly created HTTP sources, this field is required. If you send an event with the same deduplication_key multiple times, only one alert will be created in incident.io for this alert source config. You can filter on this field to find the alert created by an event you've sent us.

Example:

"4293868629"

​
id
string
required

The ID of this alert

Example:

"01GW2G3V0S59R238FAHPDS1R66"

​
status
enum<string>
required

Statuses of an alert

Available options:
firing,
resolved
Example:

"firing"

​
title
string
required

The title of the alert, parsed from the alert payload according to the alert source configuration

Example:

"*errors.withMessage: PG::Error failed to connect"

​
updated_at
string<date-time>
required

When this alert was last updated

Example:

"2021-08-17T13:28:57.801578Z"

​
description
string

The description of the alert

Example:

"CPU on the payments service has exceeded 75 percent for 5 minutes"

​
resolved_at
string<date-time>

When this alert was resolved

Example:

"2021-08-17T14:28:57.801578Z"

​
source_url
string

If applicable, a link to the alert in the upstream system

Example:

"https://www.my-alerting-platform.com/alerts/my-alert-123"