Create

Attach an alert to an incident, creating the connection between them.

The API key also needs the ‘manage incident alerts’ scope, which is what actually relates the alert once the connection exists.

If the alert is already related to this incident, the existing connection is returned unchanged. If someone previously marked the alert as unrelated to this incident, that decision is preserved and this endpoint returns a 422 — set re_relate to override it.

Private alerts can only be attached to private incidents, including when re_relate is set. An API key that cannot see the alert or the incident receives a 404.

Busy incidents can be locked by another operation, in which case this endpoint returns a 409 and the request can be retried.

Note that this endpoint returns 201 even when it re-relates or returns an existing connection rather than creating a new one.

POST

incident_alerts

Create

curl --request POST \
  --url https://api.incident.io/v2/incident_alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1",
  "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "re_relate": false
}
'

import requests

url = "https://api.incident.io/v2/incident_alerts"

payload = {
    "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1",
    "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "re_relate": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    alert_id: '01FCNDV6P870EA6S7TK1DSYDG1',
    incident_id: '01FCNDV6P870EA6S7TK1DSYDG0',
    re_relate: false
  })
};

fetch('https://api.incident.io/v2/incident_alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.incident.io/v2/incident_alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'alert_id' => '01FCNDV6P870EA6S7TK1DSYDG1',
    'incident_id' => '01FCNDV6P870EA6S7TK1DSYDG0',
    're_relate' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.incident.io/v2/incident_alerts"

	payload := strings.NewReader("{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.incident.io/v2/incident_alerts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.incident.io/v2/incident_alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}"

response = http.request(request)
puts response.read_body

{
  "incident_alert": {
    "alert": {
      "alert_group_ids": [
        "01GW2G3V0S59R238FAHPDS1R66"
      ],
      "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"
    },
    "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "incident": {
      "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"
    }
  }
}

🔑 Requires the alerts.attach_to_incident scope.

Authorizations

Authorization

string

header

required

API key from your incident.io dashboard (Settings → API keys)

Body

application/json

alert_id

string

required

Alert to attach to the incident

Example:

"01FCNDV6P870EA6S7TK1DSYDG1"

incident_id

string

required

Incident to attach the alert to

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

re_relate

boolean

default:false

Relate the alert again even though someone previously marked it unrelated to this incident. Defaults to false, which preserves that decision and returns a 422

Example:

false

Response

201 - application/json

Created response.

incident_alert

object

required

Show child attributes

Create

curl --request POST \
  --url https://api.incident.io/v2/incident_alerts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1",
  "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "re_relate": false
}
'

import requests

url = "https://api.incident.io/v2/incident_alerts"

payload = {
    "alert_id": "01FCNDV6P870EA6S7TK1DSYDG1",
    "incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "re_relate": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    alert_id: '01FCNDV6P870EA6S7TK1DSYDG1',
    incident_id: '01FCNDV6P870EA6S7TK1DSYDG0',
    re_relate: false
  })
};

fetch('https://api.incident.io/v2/incident_alerts', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.incident.io/v2/incident_alerts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'alert_id' => '01FCNDV6P870EA6S7TK1DSYDG1',
    'incident_id' => '01FCNDV6P870EA6S7TK1DSYDG0',
    're_relate' => false
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.incident.io/v2/incident_alerts"

	payload := strings.NewReader("{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.incident.io/v2/incident_alerts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.incident.io/v2/incident_alerts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"alert_id\": \"01FCNDV6P870EA6S7TK1DSYDG1\",\n  \"incident_id\": \"01FCNDV6P870EA6S7TK1DSYDG0\",\n  \"re_relate\": false\n}"

response = http.request(request)
puts response.read_body

{
  "incident_alert": {
    "alert": {
      "alert_group_ids": [
        "01GW2G3V0S59R238FAHPDS1R66"
      ],
      "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"
    },
    "alert_route_id": "01GW2G3V0S59R238FAHPDS1R67",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "incident": {
      "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"
    }
  }
}

Getting started

Webhooks

Audit logs

Deprecated endpoints

Create

Authorizations

Body

Response