curl --request POST \
--url 'https://api.flashcat.cloud/template/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"content": "Incident {{.Title}} is {{.Status}}",
"type": "feishu_app",
"incident_id": "664a1b2c3d4e5f6a7b8c9d0e",
"incident_card_hidden_fields": {
"feishu_app": [
"responders"
]
}
}
'import requests
url = "https://api.flashcat.cloud/template/preview?app_key="
payload = {
"content": "Incident {{.Title}} is {{.Status}}",
"type": "feishu_app",
"incident_id": "664a1b2c3d4e5f6a7b8c9d0e",
"incident_card_hidden_fields": { "feishu_app": ["responders"] }
}
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({
content: 'Incident {{.Title}} is {{.Status}}',
type: 'feishu_app',
incident_id: '664a1b2c3d4e5f6a7b8c9d0e',
incident_card_hidden_fields: {feishu_app: ['responders']}
})
};
fetch('https://api.flashcat.cloud/template/preview?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/template/preview?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([
'content' => 'Incident {{.Title}} is {{.Status}}',
'type' => 'feishu_app',
'incident_id' => '664a1b2c3d4e5f6a7b8c9d0e',
'incident_card_hidden_fields' => [
'feishu_app' => [
'responders'
]
]
]),
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/template/preview?app_key="
payload := strings.NewReader("{\n \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\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/template/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/template/preview?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 \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"success": true,
"content": "Incident Database latency spike is Critical",
"message": "",
"fixed_fields": [
{
"field": "channel",
"value": "Payment Alerts"
}
]
}
}{
"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."
}
}Preview template
Render a notification template against incident data or mock data and return the output.
curl --request POST \
--url 'https://api.flashcat.cloud/template/preview?app_key=' \
--header 'Content-Type: application/json' \
--data '
{
"content": "Incident {{.Title}} is {{.Status}}",
"type": "feishu_app",
"incident_id": "664a1b2c3d4e5f6a7b8c9d0e",
"incident_card_hidden_fields": {
"feishu_app": [
"responders"
]
}
}
'import requests
url = "https://api.flashcat.cloud/template/preview?app_key="
payload = {
"content": "Incident {{.Title}} is {{.Status}}",
"type": "feishu_app",
"incident_id": "664a1b2c3d4e5f6a7b8c9d0e",
"incident_card_hidden_fields": { "feishu_app": ["responders"] }
}
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({
content: 'Incident {{.Title}} is {{.Status}}',
type: 'feishu_app',
incident_id: '664a1b2c3d4e5f6a7b8c9d0e',
incident_card_hidden_fields: {feishu_app: ['responders']}
})
};
fetch('https://api.flashcat.cloud/template/preview?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/template/preview?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([
'content' => 'Incident {{.Title}} is {{.Status}}',
'type' => 'feishu_app',
'incident_id' => '664a1b2c3d4e5f6a7b8c9d0e',
'incident_card_hidden_fields' => [
'feishu_app' => [
'responders'
]
]
]),
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/template/preview?app_key="
payload := strings.NewReader("{\n \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\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/template/preview?app_key=")
.header("Content-Type", "application/json")
.body("{\n \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.flashcat.cloud/template/preview?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 \"content\": \"Incident {{.Title}} is {{.Status}}\",\n \"type\": \"feishu_app\",\n \"incident_id\": \"664a1b2c3d4e5f6a7b8c9d0e\",\n \"incident_card_hidden_fields\": {\n \"feishu_app\": [\n \"responders\"\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
"data": {
"success": true,
"content": "Incident Database latency spike is Critical",
"message": "",
"fixed_fields": [
{
"field": "channel",
"value": "Payment Alerts"
}
]
}
}{
"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 | 60 requests/minute; 10 requests/second per account |
| Permissions | None — any valid app_key can call this operation |
Usage
incident_card_hidden_fieldsapplies only to supported IM-card previews; unsupported app types or field names returnInvalidParameter.fixed_fieldsis returned only when the selected IM preview has a non-empty fixed incident-card value.
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
Template content to render.
Template channel type that selects the rendering engine.
Incident ID whose data is used to render the template; mock data is used when omitted. A MongoDB ObjectID hex string.
Incident card fields to hide per IM app when previewing.
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?