Skip to main content
POST
Preview template

Restrictions

Usage

  • incident_card_hidden_fields applies only to supported IM-card previews; unsupported app types or field names return InvalidParameter.
  • fixed_fields is returned only when the selected IM preview has a non-empty fixed incident-card value.

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

Template preview request.

content
string
required

Template content to render.

type
string
required

Template channel type that selects the rendering engine. email renders as Go html/template; other channels render as text/template. Values match the template channel fields, for example email, sms, voice, dingtalk, wecom, feishu, feishu_app, dingtalk_app, wecom_app, slack_app, teams_app, telegram, slack, zoom.

incident_id
string

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

Pattern: ^[0-9a-fA-F]{24}$
incident_card_hidden_fields
object

Incident card fields to hide per IM app when previewing.

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

Template preview result.