notification
Stable
Latest stable
Alert notification v1
notification-alert - v1
Subject: Important alert
Preheader: {{message}}
Required fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
message |
text | Yes | Message Max 1000 characters |
There is an update in your account. |
Optional fields
| Name | Type | Required | Description | Example |
|---|---|---|---|---|
actionButton.label |
text | No | Action Button Label Max 120 characters |
Review |
actionButton.url |
url | No | Action Button URL Max 2048 characters |
https://example.com/app |
alertDetails |
detailsTable | No | Alert details Details table keys: time (datetime), severity, source |
{"time":"Time","severity":"Severity","source":"Source"} |
heading |
text | No | Heading Max 180 characters |
Important alert |
preheader |
text | No | Preheader Max 220 characters |
Message |
subject |
text | No | Subject Max 180 characters |
Important alert |
Defaults
{
"actionButton.label": "Review",
"heading": "Important alert",
"message": "{{message}}",
"preheader": "{{message}}",
"subject": "Important alert"
}
Example data
{
"templateId": "notification-alert",
"data": {
"message": "{{message}}"
}
}
Template messages
| Type | Code | Message |
|---|---|---|
| Return | accepted |
Valid template data can be queued by the send endpoint. |
| Error | missing_required_variable |
Message is required. |
| Error | field_too_long |
Message must be 1000 characters or fewer. |
| Error | field_too_long |
Action Button Label must be 120 characters or fewer. |
| Error | field_too_long |
Action Button URL must be 2048 characters or fewer. |
| Error | invalid_url |
Action Button URL must be a valid http or https URL. |
| Error | invalid_details_table |
Alert details must be an object whose documented table keys are strings, numbers, or booleans. |
| Error | field_too_long |
Heading must be 180 characters or fewer. |
| Error | field_too_long |
Preheader must be 220 characters or fewer. |
| Error | field_too_long |
Subject must be 180 characters or fewer. |