curl --request POST \
--url 'https://api.flashcat.cloud/channel/escalate/rule/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 3521074710131,
"rule_name": "On-call escalation",
"template_id": "6321aad26c12104586a88916",
"description": "Notify primary on-call, then escalate to secondary after 30 minutes",
"layers": [
{
"target": {
"person_ids": [
3790925372131
],
"by": {
"follow_preference": true
}
},
"max_times": 3,
"notify_step": 10,
"escalate_window": 30,
"force_escalate": false
}
]
}
'import requests
url = "https://api.flashcat.cloud/channel/escalate/rule/create?app_key="
payload = {
"channel_id": 3521074710131,
"rule_name": "On-call escalation",
"template_id": "6321aad26c12104586a88916",
"description": "Notify primary on-call, then escalate to secondary after 30 minutes",
"layers": [
{
"target": {
"person_ids": [3790925372131],
"by": { "follow_preference": True }
},
"max_times": 3,
"notify_step": 10,
"escalate_window": 30,
"force_escalate": False
}
]
}
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({
channel_id: 3521074710131,
rule_name: 'On-call escalation',
template_id: '6321aad26c12104586a88916',
description: 'Notify primary on-call, then escalate to secondary after 30 minutes',
layers: [
{
target: {person_ids: [3790925372131], by: {follow_preference: true}},
max_times: 3,
notify_step: 10,
escalate_window: 30,
force_escalate: false
}
]
})
};
fetch('https://api.flashcat.cloud/channel/escalate/rule/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/channel/escalate/rule/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([
'channel_id' => 3521074710131,
'rule_name' => 'On-call escalation',
'template_id' => '6321aad26c12104586a88916',
'description' => 'Notify primary on-call, then escalate to secondary after 30 minutes',
'layers' => [
[
'target' => [
'person_ids' => [
3790925372131
],
'by' => [
'follow_preference' => true
]
],
'max_times' => 3,
'notify_step' => 10,
'escalate_window' => 30,
'force_escalate' => false
]
]
]),
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/channel/escalate/rule/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\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/channel/escalate/rule/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/escalate/rule/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 \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"rule_id": "69db2f72a0fe7db6448b1506",
"rule_name": "Test escalation rule"
}
}{
"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 escalation rule
Create an escalation rule defining who gets notified and when during an incident.
curl --request POST \
--url 'https://api.flashcat.cloud/channel/escalate/rule/create?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"channel_id": 3521074710131,
"rule_name": "On-call escalation",
"template_id": "6321aad26c12104586a88916",
"description": "Notify primary on-call, then escalate to secondary after 30 minutes",
"layers": [
{
"target": {
"person_ids": [
3790925372131
],
"by": {
"follow_preference": true
}
},
"max_times": 3,
"notify_step": 10,
"escalate_window": 30,
"force_escalate": false
}
]
}
'import requests
url = "https://api.flashcat.cloud/channel/escalate/rule/create?app_key="
payload = {
"channel_id": 3521074710131,
"rule_name": "On-call escalation",
"template_id": "6321aad26c12104586a88916",
"description": "Notify primary on-call, then escalate to secondary after 30 minutes",
"layers": [
{
"target": {
"person_ids": [3790925372131],
"by": { "follow_preference": True }
},
"max_times": 3,
"notify_step": 10,
"escalate_window": 30,
"force_escalate": False
}
]
}
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({
channel_id: 3521074710131,
rule_name: 'On-call escalation',
template_id: '6321aad26c12104586a88916',
description: 'Notify primary on-call, then escalate to secondary after 30 minutes',
layers: [
{
target: {person_ids: [3790925372131], by: {follow_preference: true}},
max_times: 3,
notify_step: 10,
escalate_window: 30,
force_escalate: false
}
]
})
};
fetch('https://api.flashcat.cloud/channel/escalate/rule/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/channel/escalate/rule/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([
'channel_id' => 3521074710131,
'rule_name' => 'On-call escalation',
'template_id' => '6321aad26c12104586a88916',
'description' => 'Notify primary on-call, then escalate to secondary after 30 minutes',
'layers' => [
[
'target' => [
'person_ids' => [
3790925372131
],
'by' => [
'follow_preference' => true
]
],
'max_times' => 3,
'notify_step' => 10,
'escalate_window' => 30,
'force_escalate' => false
]
]
]),
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/channel/escalate/rule/create?app_key="
payload := strings.NewReader("{\n \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\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/channel/escalate/rule/create?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/channel/escalate/rule/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 \"channel_id\": 3521074710131,\n \"rule_name\": \"On-call escalation\",\n \"template_id\": \"6321aad26c12104586a88916\",\n \"description\": \"Notify primary on-call, then escalate to secondary after 30 minutes\",\n \"layers\": [\n {\n \"target\": {\n \"person_ids\": [\n 3790925372131\n ],\n \"by\": {\n \"follow_preference\": true\n }\n },\n \"max_times\": 3,\n \"notify_step\": 10,\n \"escalate_window\": 30,\n \"force_escalate\": false\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"rule_id": "69db2f72a0fe7db6448b1506",
"rule_name": "Test escalation rule"
}
}{
"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 | Channels Manage (on-call) |
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 creating an escalation rule.
Owning channel ID; obtain it from POST /channel/list.
Notification template ID (MongoDB ObjectID).
^[0-9a-fA-F]{24}$Rule name, 1 to 39 characters.
1 - 39Escalation levels in order. At least one level is required.
Show child attributes
Show child attributes
Evaluation priority. Lower runs first.
0 <= x <= 200Delay window in seconds. 0 disables delay.
0 <= x <= 3600Rule description, up to 500 characters.
500Optional recurring time windows during which the rule applies.
Show child attributes
Show child attributes
Incident-level match conditions (OR-of-AND tree): the rule is matched against the incident the alert was grouped into, not against the alert itself. Omit or leave empty to apply the rule to all incidents in the channel.
Show child attributes
Show child attributes
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?