creating-alerts-through-events.md

Creating alerts through events

While there is the option to synchronously create alerts, we always recommend using the asynchronous events API to create and interact with alerts, especially in high volume or monitoring tool scenarios. The API endpoint allows you to not only create, but also accept, reroute and resolve alerts.

More schema based information on this can be found in the API reference.

Creating an alert:

Send a POST request to (dont forget to set the Content-Type: application/json header):

https://api.ilert.com/api/events

{
  "integrationKey": "il...", // integration key of the alert source (required)
  "eventType": "ALERT", // ALERT for creation, ACCEPT or RESOLVE (required)
  "summary": "Your alert summary", // (required)
  "details": "", // (optional) larger content description of your alert (markdown supported)
  "alertKey": "abc123", // (optional) key used to group events together or ACCEPT and existing alert
  "priority": "HIGH", // (optional) HIGH (with escalation), LOW (no escalation)
  "images": [{"src": "https://...jpeg"}], // (optional) absolute image urls, will be rendered in web/app UI
  "links": [{"href": "https://...", "text": "A link"}], // (optional) deeplinks into tools etc., will be rendered in web/app UI
  "customDetails": { "some": { "more": "fields" }} // (optional) additional fields used for templating, sharing or storing information
  "routingKey": "abc123", // (optional) overwrite escalation policy of alert source for ALERT events
}

{% hint style="danger" %} Note that the integrationKey field does not refer to a Bearer authentication token for the ilert API itself but instead to the integration key of the desired alert source. The API key can be found in the detail view of the alert source, there is no need to provide the Authorization header for the events API. {% endhint %}

Visit the web UI or the mobile app (under Alerts) to confirm your event created a corresponding alert.

More details on fields

alertKey

Used to identify other open (unresolved, unaccepted) alerts and append additional events, or accept or resolve them. The platform will always search for the last open matching alert with alertKey when processing new incoming events. The behaviour here also depends on the chosen grouping options in your alert source, for more information see Alert grouping section in:

{% content-ref url="../../alerting/alert-sources.md" %} alert-sources.md {% endcontent-ref %}

priority

By default, the priority set in the alert source will be considered as the default priority.
However, the priority can be overridden by the event, if one of the following conditions are met:

• Integration type of the alert source is Grafana or ServiceNow
• Custom priority template is configured in alert source (however in this case the template extraction might overrule the API field, depending on the configuration in your alert source)
• Default priority of alert source is set to HIGH (using support hours or setting the source to LOW will ignore your event priority field)

routingKey

The routingKey field is used to dynamically assign an escalation policy in case the event will create an new alert. By default the policy assigned to the alert source is used, however if an escalation policy with the matching routing key is found it will be used instead. (You can assign routing keys to escalation policies in their edit view)

Code samples

{% tabs %} {% tab title="Shell" %}

curl --request POST \
  --url https://api.ilert.com/api/events \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
	"integrationKey": "YOUR-ALERT-SOURCE-API-KEY",
	"eventType": "ALERT",
	"summary": "Hey, this is a test alert from the shell!"
}'

{% endtab %}

{% tab title="JavaScript" %}

const axios = require("axios").default;

const options = {
  method: 'POST',
  url: 'https://api.ilert.com/api/events',
  headers: {'Content-Type': 'application/json', Accept: 'application/json'},
  data: {
    integrationKey: 'YOUR-ALERT-SOURCE-API-KEY',
    eventType: 'ALERT',
    summary: 'Hey, this is a test alert from JS!'
  }
};

axios.request(options).then(function (response) {
  console.log(response.data);
}).catch(function (error) {
  console.error(error);
});

{% endtab %}

{% tab title="Python" %}

import requests

url = "https://api.ilert.com/api/events"

payload = {
    "integrationKey": "YOUR-ALERT-SOURCE-API-KEY",
    "eventType": "ALERT",
    "summary": "Hey, this is a test alert from Python!"
}

headers = {
    "Content-Type": "application/json",
    "Accept": "application/json"
}

response = requests.request("POST", url, json=payload, headers=headers)

print(response.text)

{% endtab %}

{% tab title="Powershell" %}

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$response = Invoke-WebRequest -Uri 'https://api.ilert.com/api/events' -Method POST -Headers $headers -ContentType 'application/json' -Body '{
	"integrationKey": "YOUR-ALERT-SOURCE-API-KEY",
	"eventType": "ALERT",
	"summary": "Hey, this is a test alert from Powershell!"
}'

{% endtab %}

{% tab title="Powershell2" %}

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("content-type", "application/json")

$body = "{`n  `"integrationKey`": `".....YOUR SOURCE API KEY....`",`n  `"eventType`": `"ALERT`",`n  `"summary`": `"string`",`n  `"details`": `"string`",`n  `"incidentKey`": `"string`",`n  `"priority`": `"HIGH`",`n  `"images`": [`n    {`n      `"src`": `"string`",`n      `"href`": `"string`",`n      `"alt`": `"string`"`n    }`n  ],`n  `"links`": [`n    {`n      `"href`": `"string`",`n      `"text`": `"string`"`n    }`n  ],`n  `"customDetails`": {}`n}"

$response = Invoke-RestMethod 'https://api.ilert.com/api/v1/events ' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json

{% endtab %} {% endtabs %}