Skip to main content
Version: 0.9.15 — archived documentation

Notification types

Path: /admin-settings → Notifications tab

Configure the types of system alerts the platform can send via email. Notification types define what events trigger alerts, who receives them, and the email content.

Notification type​

FieldRequiredDescription
CategoryYesGrouping (e.g. SCALER, USER, SYSTEM).
CodeYesUnique event code (e.g. SCALE_UP_FAILED).
NameYesHuman-readable.
DescriptionNoNotes.
SeverityYesinfo / warning / error / critical.
EnabledYesWhether active.
Rate LimitNoMin minutes between sending the same notification. Prevents flooding.

Sender​

FieldRequiredDescription
Sender NameNoDisplay name. Falls back to env.
Sender AddressNoFrom-address. Falls back to env.
RecipientsYesArray of email addresses (≥ 1).

Template parameters​

FieldDescription
ParametersVariable names usable in templates (e.g. ["environment", "serverName", "error"]).

Templates​

Templates use {{variable}} syntax. Available variables come from Parameters.

FieldRequiredDescription
Subject TemplateYesEmail subject.
Body TemplateYesHTML body.
Text TemplateNoPlain text fallback. Auto-generated from body.

Example​

SCALE_UP_FAILED with Parameters [environment, serverGroupName, currentInstances, maxInstances, error, timestamp]:

Subject: [{{severity}}] Scale Up Failed: {{serverGroupName}} in {{environment}}
<h2>Scale Up Failed</h2>
<p>
The scaler was unable to add a new instance to server group <strong>{{serverGroupName}}</strong>.
</p>
<table>
<tr>
<td>Environment</td>
<td>{{environment}}</td>
</tr>
<tr>
<td>Current Instances</td>
<td>{{currentInstances}}</td>
</tr>
<tr>
<td>Max Instances</td>
<td>{{maxInstances}}</td>
</tr>
<tr>
<td>Error</td>
<td>{{error}}</td>
</tr>
<tr>
<td>Time</td>
<td>{{timestamp}}</td>
</tr>
</table>

Workflows​

Create a notification type​

Click Create → Category + Code + Name → Severity → Parameters → Recipients → Subject + Body templates → optionally Rate Limit → enable → save.

Test a notification​

Notifications are triggered by system events. Use the template preview in the edit dialog to validate rendering.

See also​