Skip to main content
POST
/
incident
/
{id}
/
note
Create a Note for Incident
curl --request POST \
  --url https://api.alerty.ai/incident/{id}/note \
  --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",
  "createdBy": {
    "id": "<string>",
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "emailVerified": true,
    "profilePictureURL": "<string>"
  },
  "content": "<string>"
}
'
import requests

url = "https://api.alerty.ai/incident/{id}/note"

payload = {
"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',
createdBy: {
id: '<string>',
email: '<string>',
firstName: '<string>',
lastName: '<string>',
emailVerified: true,
profilePictureURL: '<string>'
},
content: '<string>'
})
};

fetch('https://api.alerty.ai/incident/{id}/note', 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/{id}/note",
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',
'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/{id}/note"

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 \"createdBy\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailVerified\": true,\n \"profilePictureURL\": \"<string>\"\n },\n \"content\": \"<string>\"\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/{id}/note")
.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 \"createdBy\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailVerified\": true,\n \"profilePictureURL\": \"<string>\"\n },\n \"content\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.alerty.ai/incident/{id}/note")

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 \"createdBy\": {\n \"id\": \"<string>\",\n \"email\": \"<string>\",\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"emailVerified\": true,\n \"profilePictureURL\": \"<string>\"\n },\n \"content\": \"<string>\"\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",
  "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"
}
{
"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.

Path Parameters

id
string<uuid>
required

the incident identifier Unique identifier for the entity

Example:

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

Body

application/json

the incident note added by the user

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
createdBy
object
required
content
string
required

the incident note content

Response

resource created

the incident note added by the user

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
createdBy
object
required
content
string
required

the incident note content