curl --request POST \
--url 'https://api.flashcat.cloud/incident/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"channel_id": 123,
"assigned_to": {
"person_ids": [
123
],
"escalate_rule_id": "<string>",
"layer_idx": 123,
"emails": [
"jsmith@example.com"
],
"notify": {
"follow_preference": true,
"personal_channels": [
"<string>"
],
"template_id": "<string>"
}
},
"fields": {}
}
'import requests
url = "https://api.flashcat.cloud/incident/create?app_key="
payload = {
"title": "<string>",
"description": "<string>",
"channel_id": 123,
"assigned_to": {
"person_ids": [123],
"escalate_rule_id": "<string>",
"layer_idx": 123,
"emails": ["jsmith@example.com"],
"notify": {
"follow_preference": True,
"personal_channels": ["<string>"],
"template_id": "<string>"
}
},
"fields": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
channel_id: 123,
assigned_to: {
person_ids: [123],
escalate_rule_id: '<string>',
layer_idx: 123,
emails: ['jsmith@example.com'],
notify: {
follow_preference: true,
personal_channels: ['<string>'],
template_id: '<string>'
}
},
fields: {}
})
};
fetch('https://api.flashcat.cloud/incident/create?app_key=', 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.flashcat.cloud/incident/create?app_key=",
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([
'title' => '<string>',
'description' => '<string>',
'channel_id' => 123,
'assigned_to' => [
'person_ids' => [
123
],
'escalate_rule_id' => '<string>',
'layer_idx' => 123,
'emails' => [
'jsmith@example.com'
],
'notify' => [
'follow_preference' => true,
'personal_channels' => [
'<string>'
],
'template_id' => '<string>'
]
],
'fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"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.flashcat.cloud/incident/create?app_key="
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/incident/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/incident/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"incident_id": "69db2ef1a0fe7db6448b14f1",
"title": "API test incident for docs"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Create incident
Manually create a new incident and assign responders.
curl --request POST \
--url 'https://api.flashcat.cloud/incident/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"title": "<string>",
"description": "<string>",
"channel_id": 123,
"assigned_to": {
"person_ids": [
123
],
"escalate_rule_id": "<string>",
"layer_idx": 123,
"emails": [
"jsmith@example.com"
],
"notify": {
"follow_preference": true,
"personal_channels": [
"<string>"
],
"template_id": "<string>"
}
},
"fields": {}
}
'import requests
url = "https://api.flashcat.cloud/incident/create?app_key="
payload = {
"title": "<string>",
"description": "<string>",
"channel_id": 123,
"assigned_to": {
"person_ids": [123],
"escalate_rule_id": "<string>",
"layer_idx": 123,
"emails": ["jsmith@example.com"],
"notify": {
"follow_preference": True,
"personal_channels": ["<string>"],
"template_id": "<string>"
}
},
"fields": {}
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
title: '<string>',
description: '<string>',
channel_id: 123,
assigned_to: {
person_ids: [123],
escalate_rule_id: '<string>',
layer_idx: 123,
emails: ['jsmith@example.com'],
notify: {
follow_preference: true,
personal_channels: ['<string>'],
template_id: '<string>'
}
},
fields: {}
})
};
fetch('https://api.flashcat.cloud/incident/create?app_key=', 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.flashcat.cloud/incident/create?app_key=",
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([
'title' => '<string>',
'description' => '<string>',
'channel_id' => 123,
'assigned_to' => [
'person_ids' => [
123
],
'escalate_rule_id' => '<string>',
'layer_idx' => 123,
'emails' => [
'jsmith@example.com'
],
'notify' => [
'follow_preference' => true,
'personal_channels' => [
'<string>'
],
'template_id' => '<string>'
]
],
'fields' => [
]
]),
CURLOPT_HTTPHEADER => [
"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.flashcat.cloud/incident/create?app_key="
payload := strings.NewReader("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
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.flashcat.cloud/incident/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/incident/create?app_key=")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"<string>\",\n \"description\": \"<string>\",\n \"channel_id\": 123,\n \"assigned_to\": {\n \"person_ids\": [\n 123\n ],\n \"escalate_rule_id\": \"<string>\",\n \"layer_idx\": 123,\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"notify\": {\n \"follow_preference\": true,\n \"personal_channels\": [\n \"<string>\"\n ],\n \"template_id\": \"<string>\"\n }\n },\n \"fields\": {}\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"incident_id": "69db2ef1a0fe7db6448b14f1",
"title": "API test incident for docs"
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InvalidParameter",
"message": "The specified parameter is not valid."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "Unauthorized",
"message": "You are unauthorized."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "RequestTooFrequently",
"message": "Request too frequently."
}
}{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"error": {
"code": "InternalError",
"message": "We encountered an internal error, and it has been reported. Please try again later."
}
}Restrictions
| Aspect | Value |
|---|---|
| Rate limits | 1,000 requests/minute; 50 requests/second per account |
| Permissions | Incidents Manage (on-call) |
Usage
- When an account create form applies, its visible custom fields and required system values must be supplied.
- To attach images, send
multipart/form-datawith the JSON request indataand files inimages; the complete request must not exceed 50 MiB. - Audited — changes are recorded in the audit log.
Authorizations
App key issued from the Flashduty console under Account → APP Keys. Required on every public API call. Keep it secret — it grants the same access as the owning account.
Body
Parameters for manually creating an incident.
Incident severity: Info, Warning or Critical (most severe).
Info, Warning, Critical Incident title, up to 512 characters.
512Incident description, up to 1024 characters.
1024Channel to file the incident into. Optional; leave unset for a standalone incident.
Incident assignment target. May be omitted entirely: when unset or empty, the channel's default assignment applies; required when the account's create form is in effect. person_ids, escalate_rule_id, and emails can be combined — responders are the union.
Show child attributes
Show child attributes
Custom field values keyed by field name. When a create form applies, only its visible fields are accepted.
Response
Success
Success response envelope. On every 2xx response, request_id identifies the call (also mirrored in the Flashcat-Request-Id header) and data holds the endpoint-specific payload. Failure responses use a different shape — see ErrorResponse.
Was this page helpful?