The Notification Templates section lets you create message texts that will be sent to your users via email or internal notifications in CP. Notification templates are used when setting up a subscription for your users. There are two types of notification templates: system templates that come pre-installed with OnApp and cannot be deleted but only edited, and custom templates which you add to your cloud.

To view your notification templates go to your Control Panel > Admin > Notification Templates menu. The page that loads shows your notification templates with their labels, indicators whether this is a system or a custom template and the template's text. If a template contains a long message, only the beginning of the text will be displayed.


Add Notification Templates

To add a new notification template:

  1. Go to your Control Panel > Admin > Notification Templates menu.
  2. Click the New notification template button lower right or upper right.
  3. On the page that loads, fill in the label and the text of the template. The label of the template should not contain any special characters. The text of the template is the message which your users will receive.
  4. Click the Submit button to add the notification template.

If you add a '%{message}' text to the template, the notification will contain the full text of the event that is written into logs. If you add a '%{name}' text to the template, the notification will contain the name of the user who will receive the notification. You can set %{message} and %{name} placeholders for almost any type of event, however, the following events will have the different placeholders available:

  • federation new announcement - {label} and {period_for_federation_announcement} placeholders.
  • federation templates changed - {label} placeholder.

For custom events you can only set the %{message} and %{name} placeholders. 


Manage Notification Templates

Notification templates include message texts that will be sent to your users via email or internal notifications in CP. There are two types of notification templates: system templates that come pre-installed with OnApp and cannot be deleted but only edited, and custom templates which you add to your cloud. To view your notification templates go to your Control Panel > AdminNotification Templates menu. The page that loads shows your notification templates with their names, indicators whether this is a system or a custom template and the template's text. If a template contains a long message, only the beginning of the text will be displayed.

Edit Notification Template

To edit a notification template:

  1. Go to your Control Panel > Admin > Notification Templates menu.
  2. Click the Actions button next to the required template and select Edit.
  3. On the page that loads, you can edit the name and the text of the template. The name of the template should not contain any special characters. After editing the text you can save the changes or restore it to the default.
    When editing a system template, you can configure if HTTP or HTTPS should used in the links sent in the notifications.
  4. Click Submit for the changes to take effect.

To edit system notification templates you need to have the the Update notification template permission enabled. You can also restore the message of a system template to default at your Control Panel > AdminNotification Templates > Actions button > Restore to default.

If you add a '%{message}' text to the template, the notification will contain the full text of the event that is written into logs. If you add a '%{name}' text to the template, the notification will contain the name of the user who will receive the notification. You can set the %{message} and %{name} placeholders for almost any type of event, however, the following events will have the different placeholders avalable:

  • federation new announcement - {label} and {period_for_federation_announcement} placeholders.
  • federation templates changed - {label} placeholder.

For custom events you can only set the %{message} and %{name} placeholders. 

Delete Notification Template

To delete a notification template:

  1. Go to your Control Panel > AdminNotification Templates menu.
  2. Click the Actions button next to the required template and select Delete.

A notification template that is associated with at least one subscription cannot be deleted.

System notification templates for the reset password, account lock and transaction approval cannot be deleted.


Leave feedback