Skip to main content
POST
/
template
/
preview
Preview template
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"
}
'
{
  "request_id": "01HK8XQE3Z7JM2NTFQ5YJ8P9R4",
  "data": {
    "success": true,
    "content": "Incident Database latency spike is Critical",
    "message": ""
  }
}

​
Restrictions

AspectValue
Rate limits60 requests/minute; 10 requests/second per account
PermissionsNone — any valid app_key can call this operation

Authorizations

​
app_key
string
query
required

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

application/json
​
content
string
required

Template content to render.

​
type
string
required

Template channel type that selects the rendering engine.

​
incident_id
string

Incident ID whose data is used to render the template; mock data is used when omitted. A MongoDB ObjectID hex string.

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.

​
request_id
string
required

Unique ID for this request. Mirrored in the Flashcat-Request-Id response header. Include it when reporting issues.

Example:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

​
data
object
required

Endpoint-specific payload. See each operation's 200 response schema.