Skip to main content
POST
/
incident
Create an Incident
curl --request POST \
  --url https://api.alerty.ai/incident \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "description": "<string>",
  "acknowledgedAt": "2023-11-07T05:31:56Z",
  "reopenedAt": "2023-11-07T05:31:56Z",
  "closedAt": "2023-11-07T05:31:56Z",
  "resolvedAt": "2023-11-07T05:31:56Z",
  "snoozedUntil": "2023-11-07T05:31:56Z",
  "notes": [
    {
      "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "id": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "emailVerified": true,
        "profilePictureURL": "<string>"
      },
      "content": "<string>"
    }
  ]
}
'
import requests

url = "https://api.alerty.ai/incident"

payload = {
    "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "title": "<string>",
    "description": "<string>",
    "acknowledgedAt": "2023-11-07T05:31:56Z",
    "reopenedAt": "2023-11-07T05:31:56Z",
    "closedAt": "2023-11-07T05:31:56Z",
    "resolvedAt": "2023-11-07T05:31:56Z",
    "snoozedUntil": "2023-11-07T05:31:56Z",
    "notes": [
        {
            "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "createdBy": {
                "id": "<string>",
                "email": "<string>",
                "firstName": "<string>",
                "lastName": "<string>",
                "emailVerified": True,
                "profilePictureURL": "<string>"
            },
            "content": "<string>"
        }
    ]
}
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({
    id: '5df33a85-2b9c-40e3-8854-760ee3b8efc7',
    createdAt: '2023-11-07T05:31:56Z',
    updatedAt: '2023-11-07T05:31:56Z',
    title: '<string>',
    description: '<string>',
    acknowledgedAt: '2023-11-07T05:31:56Z',
    reopenedAt: '2023-11-07T05:31:56Z',
    closedAt: '2023-11-07T05:31:56Z',
    resolvedAt: '2023-11-07T05:31:56Z',
    snoozedUntil: '2023-11-07T05:31:56Z',
    notes: [
      {
        id: '5df33a85-2b9c-40e3-8854-760ee3b8efc7',
        createdAt: '2023-11-07T05:31:56Z',
        updatedAt: '2023-11-07T05:31:56Z',
        createdBy: {
          id: '<string>',
          email: '<string>',
          firstName: '<string>',
          lastName: '<string>',
          emailVerified: true,
          profilePictureURL: '<string>'
        },
        content: '<string>'
      }
    ]
  })
};

fetch('https://api.alerty.ai/incident', 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.alerty.ai/incident",
  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([
    'id' => '5df33a85-2b9c-40e3-8854-760ee3b8efc7',
    'createdAt' => '2023-11-07T05:31:56Z',
    'updatedAt' => '2023-11-07T05:31:56Z',
    'title' => '<string>',
    'description' => '<string>',
    'acknowledgedAt' => '2023-11-07T05:31:56Z',
    'reopenedAt' => '2023-11-07T05:31:56Z',
    'closedAt' => '2023-11-07T05:31:56Z',
    'resolvedAt' => '2023-11-07T05:31:56Z',
    'snoozedUntil' => '2023-11-07T05:31:56Z',
    'notes' => [
        [
                'id' => '5df33a85-2b9c-40e3-8854-760ee3b8efc7',
                'createdAt' => '2023-11-07T05:31:56Z',
                'updatedAt' => '2023-11-07T05:31:56Z',
                'createdBy' => [
                                'id' => '<string>',
                                'email' => '<string>',
                                'firstName' => '<string>',
                                'lastName' => '<string>',
                                'emailVerified' => true,
                                'profilePictureURL' => '<string>'
                ],
                'content' => '<string>'
        ]
    ]
  ]),
  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.alerty.ai/incident"

	payload := strings.NewReader("{\n  \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"acknowledgedAt\": \"2023-11-07T05:31:56Z\",\n  \"reopenedAt\": \"2023-11-07T05:31:56Z\",\n  \"closedAt\": \"2023-11-07T05:31:56Z\",\n  \"resolvedAt\": \"2023-11-07T05:31:56Z\",\n  \"snoozedUntil\": \"2023-11-07T05:31:56Z\",\n  \"notes\": [\n    {\n      \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\",\n      \"createdBy\": {\n        \"id\": \"<string>\",\n        \"email\": \"<string>\",\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"emailVerified\": true,\n        \"profilePictureURL\": \"<string>\"\n      },\n      \"content\": \"<string>\"\n    }\n  ]\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.alerty.ai/incident")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"acknowledgedAt\": \"2023-11-07T05:31:56Z\",\n  \"reopenedAt\": \"2023-11-07T05:31:56Z\",\n  \"closedAt\": \"2023-11-07T05:31:56Z\",\n  \"resolvedAt\": \"2023-11-07T05:31:56Z\",\n  \"snoozedUntil\": \"2023-11-07T05:31:56Z\",\n  \"notes\": [\n    {\n      \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\",\n      \"createdBy\": {\n        \"id\": \"<string>\",\n        \"email\": \"<string>\",\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"emailVerified\": true,\n        \"profilePictureURL\": \"<string>\"\n      },\n      \"content\": \"<string>\"\n    }\n  ]\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.alerty.ai/incident")

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  \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n  \"createdAt\": \"2023-11-07T05:31:56Z\",\n  \"updatedAt\": \"2023-11-07T05:31:56Z\",\n  \"title\": \"<string>\",\n  \"description\": \"<string>\",\n  \"acknowledgedAt\": \"2023-11-07T05:31:56Z\",\n  \"reopenedAt\": \"2023-11-07T05:31:56Z\",\n  \"closedAt\": \"2023-11-07T05:31:56Z\",\n  \"resolvedAt\": \"2023-11-07T05:31:56Z\",\n  \"snoozedUntil\": \"2023-11-07T05:31:56Z\",\n  \"notes\": [\n    {\n      \"id\": \"5df33a85-2b9c-40e3-8854-760ee3b8efc7\",\n      \"createdAt\": \"2023-11-07T05:31:56Z\",\n      \"updatedAt\": \"2023-11-07T05:31:56Z\",\n      \"createdBy\": {\n        \"id\": \"<string>\",\n        \"email\": \"<string>\",\n        \"firstName\": \"<string>\",\n        \"lastName\": \"<string>\",\n        \"emailVerified\": true,\n        \"profilePictureURL\": \"<string>\"\n      },\n      \"content\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body
{
  "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "title": "<string>",
  "description": "<string>",
  "monitor": {
    "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "name": "<string>",
    "resourceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "recipients": [
      {
        "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "integration": {
          "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "configuration": {
            "teamId": "<string>",
            "accessToken": "<string>",
            "incomingWebhookURL": "<string>",
            "channelID": "<string>"
          }
        },
        "integrationOverride": {
          "teamId": "<string>",
          "accessToken": "<string>",
          "incomingWebhookURL": "<string>",
          "channelID": "<string>"
        }
      }
    ],
    "pollDurationInterval": "P3Y6M4DT12H30M5S",
    "description": "<string>",
    "snoozedUntil": "2023-11-07T05:31:56Z",
    "query": "<string>",
    "resource": {
      "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "configuration": {
        "url": "<string>"
      }
    }
  },
  "createdBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "acknowledgedAt": "2023-11-07T05:31:56Z",
  "acknowledgedBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "reopenedAt": "2023-11-07T05:31:56Z",
  "reopenedBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "closedAt": "2023-11-07T05:31:56Z",
  "closedBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "resolvedAt": "2023-11-07T05:31:56Z",
  "resolvedBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "snoozedUntil": "2023-11-07T05:31:56Z",
  "snoozeddBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "notes": [
    {
      "id": "5df33a85-2b9c-40e3-8854-760ee3b8efc7",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "createdBy": {
        "id": "<string>",
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>",
        "emailVerified": true,
        "profilePictureURL": "<string>"
      },
      "content": "<string>"
    }
  ]
}
{
  "description": "A descriptive error message",
  "code": 1400,
  "field": "name"
}
{
  "description": "A descriptive error message",
  "code": 1400,
  "field": "name"
}
{
  "description": "A descriptive error message",
  "code": 1400,
  "field": "name"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

an incident trigged by a monitor/alert

​
id
string<uuid>
required

Unique identifier for the entity

Example:

"5df33a85-2b9c-40e3-8854-760ee3b8efc7"

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
title
string
required

the incident title

​
state
enum<string>
required

state of the incident during its lifecycle

Available options:
ACTIVE,
ACKNOWLEDGED,
SNOOZED,
RESOLVED,
CLOSED,
REOPENED
​
description
string

the incident description field

​
monitor
object

resource monitor

​
createdBy
object
​
acknowledgedAt
string<date-time>

timestamp when incident was acknowledged

​
acknowledgedBy
object
​
reopenedAt
string<date-time>

timestamp when incident was reopened

​
reopenedBy
object
​
closedAt
string<date-time>

timestamp when incident was closed

​
closedBy
object
​
resolvedAt
string<date-time>

timestamp when incident was closed

​
resolvedBy
object
​
snoozedUntil
string<date-time>

until when the monitor will be in snoozed mode

​
snoozeddBy
object
​
notes
object[]

list of incidents notes

Response

incident created

an incident trigged by a monitor/alert

​
id
string<uuid>
required

Unique identifier for the entity

Example:

"5df33a85-2b9c-40e3-8854-760ee3b8efc7"

​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
title
string
required

the incident title

​
state
enum<string>
required

state of the incident during its lifecycle

Available options:
ACTIVE,
ACKNOWLEDGED,
SNOOZED,
RESOLVED,
CLOSED,
REOPENED
​
description
string

the incident description field

​
monitor
object

resource monitor

​
createdBy
object
​
acknowledgedAt
string<date-time>

timestamp when incident was acknowledged

​
acknowledgedBy
object
​
reopenedAt
string<date-time>

timestamp when incident was reopened

​
reopenedBy
object
​
closedAt
string<date-time>

timestamp when incident was closed

​
closedBy
object
​
resolvedAt
string<date-time>

timestamp when incident was closed

​
resolvedBy
object
​
snoozedUntil
string<date-time>

until when the monitor will be in snoozed mode

​
snoozeddBy
object
​
notes
object[]

list of incidents notes