Preview template
Render a notification template against incident data or mock data and return the output.
Restrictions
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.
Fields to hide by IM app when previewing an incident card. Only supported IM app types and field names 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.