Alerts V2

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.

List Alerts V2

List all alerts for your account.

This endpoint supports a number of filters, which can help find alerts matching certain criteria. These filters work similarly to the filters on the incidents endpoint, where a field is specified alongside a comparison operator in the query string.

Note that:

  • Filters may be used together, and the result will be alerts that match all filters.
  • All query parameters must be URI encoded.

By deduplication_key

Find all alerts with deduplication_key ABC:

    curl --get 'https://api.incident.io/v2/alerts' \
        --data 'deduplication_key[is]=ABC'

By status

Find all alerts in a firing state:

    curl --get 'https://api.incident.io/v2/alerts' \
        --data 'status[one_of]=firing'
Request
query Parameters
page_size
required
integer <int64> [ 1 .. 50 ]
Default: 25

Number of alerts to return per page

Example: page_size=25
after
string

If provided, pass this as the 'after' param to load the next page

Example: after=01FCNDV6P870EA6S7TK1DSYDG0
object

Filter on alert deduplication key. The accepted operator is 'is'.

Example: is=01GBSQF3FHF7FWZQNWGHAVQ804
object

Filter on alert status. The accepted operators are 'one_of', or 'not_in'.

Example: one_of=firing
Responses
200

OK response.

get/v2/alerts
Request samples 
Response samples 
application/json
{
  • "alerts": [
    ],
  • "pagination_meta": {
    }
}
Show Alerts V2
Show a single alert for your account


Request 
path Parameters
id
required
string
Unique identifier for the alert


 
 Example:  01FDAG4SAP5TYPT98WGR2N7W91
Responses 
200
OK response.


get/v2/alerts/{id}
Request samples 
Response samples 
application/json
{
  • "alert": {
    }
}
ListIncidentAlerts Alerts V2
List the connections between incidents and alerts


Request 
query Parameters
page_size
required
integer <int64>   [ 1 .. 50 ] 
 Default:  25
Number of incident alerts to return per page


 
 Example:  page_size=25
after
string
If provided, pass this as the 'after' param to load the next page


 
 Example:  after=01FCNDV6P870EA6S7TK1DSYDG0
alert_id
string
Alert that this incident alert refers to


 
 Example:  alert_id=01FCNDV6P870EA6S7TK1DSYDG1
incident_id
string
Incident that this incident alert is attached to


 
 Example:  incident_id=01FCNDV6P870EA6S7TK1DSYDG0
Responses 
200
OK response.


get/v2/incident_alerts
Request samples 
Response samples 
application/json
{
  • "incident_alerts": [
    ],
  • "pagination_meta": {
    }
}
➔ Next to Catalog V2