Templates

Get alert template

Retrieves the configuration and content of a specific alert notification template. Returns the template structure including message format, variable definitions, styling options, and other formatting parameters. Used for reviewing existing templates and understanding notification formats before making modifications.

get/api/{org_id}/alerts/templates/{template_name}

Request

Path parameters

org_idstring required

Organization name

template_namestring required

Template name

Response

Success

applies_tostring[] nullable

Kinds the template is meant for; [] is every kind. Absent on update keeps the stored list.

bodystring
isDefaultboolean nullable
isPrebuiltboolean

True for system-managed prebuilt templates (those whose name starts with prebuilt_). The public API refuses updates and deletes for these, so the UI should render them as read-only.

kindstring nullable

Template kind: "custom" (default) or "content". Absent on write means "unspecified" — create defaults to custom, update preserves the stored kind (sticky-kind rule, design §6.2).

namestring
titlestring
type'http' | 'email' | 'sns' | 'slack_app'

Changes

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