Templates

Preview an alert template

Renders a draft content-template definition for a chosen channel against a deterministic synthetic sample, returning both the real wire payload the send path would produce and a normalized preview model for card rendering. Uses the exact same resolve/render code path as sending a live notification, so the preview is guaranteed to match production output for the same input.

post/api/{org_id}/alerts/templates/preview

Request

Path parameters

org_idstring required

Organization name

Request body

channelstring required

"slack" | "teams_adaptivecard" | "teams_messagecard" | "email" | "webhook" | "discord" | "pagerduty" | "opsgenie" | "servicenow" | "sns"

kind'alert' | 'incident' | 'anomaly' | 'synthetics' | 'downtime' | 'on_call'
sampleunknown
severitystring nullable

"critical" | "warning" | "ok" | "no_data" | "single_level" (default)

Response

Success

empty_variablesstring[] required

Variables the draft uses that render blank in the previewed kind's sample.

payloadunknown required
unknown_variablesstring[] required
variablesstring[] required

Every variable a template of the requested kind can use.

Changes

No recorded changes to this operation across all 1 revision of this API.