In this section · 4 articles

Notification Manager settings

Every field on the Email, SMS, WhatsApp and Push settings panels, the Sender IDs and Business Events forms, the Webhook Center, and the permissions that control each screen.

Applies to
Notification Manager 1.4 and later
Who can do this
Platform owner
Where
Notification Manager › Settings
On this page

The four provider panels open in the Settings hub, under Notification Providers. To see them you need View Providers & Settings (feature.nm.provider.view), and to change them Edit Providers & Settings (feature.nm.provider.edit). Select Save changes to save a panel. See How the settings hub works.

Password, token and key fields never show the saved value. Leave one empty to keep it.

Fields on every provider tab

FieldWhat it doesNotes
StatusActive sends this channel's messages through the provider. Inactive doesn't use it.Switching to Active, or changing an active provider's details, runs a connection test first. If it fails, nothing is saved.
PriorityThe order Laramin tries a channel's active providers in, lowest number first.At least 1. SMTP and Twilio are their channel's default and are always tried first while active. [Confirm: Priority doesn't move them in 1.5.0.]

Each tab has a test button, such as Test SMTP connection. It checks the details typed on screen, and the saved value for any secret left empty. It doesn't send a message.

The Settings hub's Notification Providers group, listing Email Settings, SMS Settings, WhatsApp Settings and Push Settings, with Email Settings selected.

Email Settings

Out of the box, SMTP is Active with placeholder details (127.0.0.1, port 1025, from noreply@company.com), and AWS SES is Inactive with Priority 2.

SMTP

FieldWhat it doesDefault
SMTP HostYour mail server, for example smtp.example.com. Required to test.
SMTP PortThe server's port.587 when empty
EncryptionTLS or SSL.TLS when empty
SMTP UsernameThe user to sign in as.
SMTP PasswordThat user's password.
From AddressThe address emails come from, for example notifications@example.com, unless a sender ID says otherwise.no-reply@company.com when empty
From NameThe name emails come from.Your Laramin's app name when empty
Email Header HTMLHTML put before every email's body.Used only when Email Template Base is empty
Email Footer HTMLHTML put after every email's body.Used only when Email Template Base is empty
The Email Settings panel on the SMTP tab, showing Status, Priority, host, port, encryption, sign-in, sender and header and footer HTML fields, with the Test SMTP connection button above.

AWS SES

FieldWhat it doesDefault
AWS Access Key IDThe access key of an AWS user that may send with SES. Required.
AWS Secret Access KeyIts secret. Required.
AWS RegionThe SES region, for example eu-west-1.us-east-1 when empty
From AddressThe verified address emails come from.no-reply@company.com when empty
From NameThe name emails come from.Your Laramin's app name when empty
The Email Settings panel on the AWS SES tab, showing Status, Priority, access key, secret key, region, From Address and From Name fields, with the Test AWS SES connection button above.

Email Template Base

A visual builder for the layout every email is wrapped in, for SMTP and SES alike. Load starter: replaces your design with a ready-made one, after asking Load this starter template? It will replace your current design. Put the content marker {{{ content }}} where each message's body goes. If it's missing, the body is added at the end. You can use variables such as {{SYSTEM_NAME}} in the layout.

The Email Settings panel on the Email Template Base tab, showing the Load starter: menu, the visual builder with a {{SYSTEM_NAME}} header and {{{ content }}} marker, and the available variables list.

SMS Settings

Both providers start Inactive: Twilio with Priority 1, Msg91 with Priority 2.

Twilio

FieldWhat it does
Account SIDYour Twilio account SID. Required.
Auth TokenIts auth token. Required. Also used to check that delivery reports really come from Twilio.
From NumberThe Twilio number messages come from, for example +15550100000, unless a sender ID says otherwise.
The SMS Settings panel on the Twilio tab, showing Status set to Inactive, Priority 1, and the Account SID, Auth Token and From Number fields, with the Test Twilio connection button above.

Msg91

FieldWhat it doesNotes
Auth KeyYour Msg91 auth key. Required.
Sender IDThe approved sender name, unless a sender ID or template says otherwise.
RouteTransactional (4) or Promotional (1).[Confirm: 1.5.0 always sends as transactional.]
DLT Template IDA DLT template ID.[Confirm: not used in 1.5.0. Set the DLT template per template, in the Template Builder.]
SMS Settings panel with the Msg91 tab open, showing Status (Inactive), Priority (2), Auth Key, Sender ID, Route and DLT Template ID fields.

WhatsApp Settings

The Meta WhatsApp Cloud API provider starts Inactive.

FieldWhat it doesNotes
Access TokenA Meta access token that may send WhatsApp messages. Required.
Phone Number IDThe ID of your WhatsApp business phone number in Meta. Required.
Business Account IDYour WhatsApp Business Account ID.[Confirm: saved, not used in 1.5.0.]
API VersionThe Meta Graph API version.[Confirm: 1.5.0 always uses version 17.0.]
App SecretYour Meta app's secret, from App settings › Basic in your Meta app.Used to check that delivery reports really come from Meta. Without it, Meta's delivery reports are refused. Sending works either way.
WhatsApp Settings panel showing Status (Inactive), Priority, Access Token, Phone Number ID, Business Account ID, API Version and App Secret fields, with the Test WhatsApp connection button.

Push Settings

The Firebase Cloud Messaging provider starts Inactive.

FieldWhat it doesNotes
FCM Server KeyA key for Firebase's old (legacy) sending method.Leave it empty. When it's filled in, Laramin sends with it, even if the service account is also set.
Service Account JSONThe JSON key of a Firebase service account. Paste the whole file.Laramin reads the project ID from it.
Project IDYour Firebase project ID.[Confirm: not used in 1.5.0. The project ID comes from the service account.]
Push Settings panel for Firebase Cloud Messaging showing Status (Inactive), Priority, FCM Server Key, Service Account JSON and Project ID fields, with the Test Firebase FCM connection button.

Push messages go to the device token Laramin holds for the person.

Sender IDs

Notification Manager › Settings › Sender IDs. See Add a sender ID.

FieldWhat it doesRules
ProviderThe provider the sender belongs to.Required
ChannelEmail, SMS or WhatsApp.Required
Sender IdentityThe address, sender name or number.Email: an email address. SMS: 3 to 11 letters and digits. WhatsApp: a phone number, for example +15550100000.
Country CodeUS, IN and so on, or * for all.Required. [Confirm: not used to pick a sender in 1.5.0.]
DefaultMakes it the first choice for its provider and channel.
StatusOnly active senders are used.
Create Sender Identities form with empty Provider and Channel dropdowns, blank Sender Identity and Country Code fields, and the Default and Status toggles switched off.

Business events

Notification Manager › Business Events. Core and your add-ons add their events for you. New Business Events adds your own, which is only useful if something in your Laramin fires that event key.

FieldWhat it doesNotes
Event KeyThe key that fires the event, for example user.password_reset.Must be unique. Can't be changed later.
NameThe name people see, in lists and in Notification Preferences.Required
CategoryA group, such as Security.Required
ModuleCore, or the add-on the event belongs to.The event isn't sent while that add-on is turned off.
DescriptionWhat the event is for.
Provider Parameter SetsThe groups of variables the Template Builder offers, such as User Parameters.
Default ChannelsA list of channels.Saved, but not used for sending. The channels sent are the ones with a template that has Enable Dispatch on.
Required VariablesVariables the event should always supply, such as USER_NAME.A missing one is noted in the server's log and left blank. The message is still sent.
StatusOn sends the event. Off stops it on every channel.See Turn a notification on or off.
The empty Create Business Events form, with Event Key, Name and Category marked required, then Module, Description, Provider Parameter Sets, Default Channels, Required Variables and the Status switch.

The fields of each template are listed in Edit a message template and send a test.

Webhook Center

Notification Manager › Settings › Webhook Center lists the addresses your SMS and WhatsApp providers send delivery reports to: Twilio Status Callback URL, Msg91 DLR Webhook URL and Meta WhatsApp Webhook URL, each with Copy URL and setup notes. See Check what was sent.

  • The Msg91 address ends in a secret for your Laramin. Treat it like a password.
  • The Meta card shows your Laramin's own verify token.
  • A card shows a warning while that provider's reports are refused: No Twilio Auth Token is saved, so Twilio status callbacks are refused. Add it under SMS Settings., or No Meta App Secret is saved, so WhatsApp status updates are refused. Add it under WhatsApp Settings.
The Webhook Center with Twilio SMS, Msg91 SMS and Meta WhatsApp Cloud API cards, each with its URL, copy button and setup notes. Twilio and Meta show refused-callback warnings; the verify token is masked.

A delivery report that fails the check is refused and changes nothing.

Permissions

PermissionAllows
feature.nm.event.listList Notification Events: opening Business Events.
feature.nm.event.viewView Notification Event: opening an event, and the Dashboard.
feature.nm.event.createCreate Notification Event.
feature.nm.event.editEdit Notification Event, including its Status.
feature.nm.event.deleteDelete Notification Event (to the deleted list).
feature.nm.event.restoreRestore Notification Event.
feature.nm.event.removePermanently Remove Notification Event.
feature.nm.template.editEdit Templates (Builder): opening the Template Builder, saving and submitting templates.
feature.nm.template.sendSend Test Notification: tests from the Template Builder and the Test Center.
feature.nm.template.approveApprove / Reject Templates.
feature.nm.provider.viewView Providers & Settings: the four provider panels and the Webhook Center.
feature.nm.provider.editEdit Providers & Settings: changing and testing providers, and the email layout.
feature.nm.sender_identity.listList Sender Identities: opening Sender IDs.
feature.nm.sender_identity.view / .create / .edit / .delete / .restore / .removeViewing, adding, changing, deleting, restoring and permanently removing sender IDs.
feature.nm.log.listList Notification Logs: opening Delivery Logs and a log's details.
feature.nm.log.viewView Notification Logs.
feature.nm.log.clearClear Notification Logs.
feature.nm.preference.editManage Notification Preferences. Not checked: everyone can set their own preferences.

To give them, see Give someone a role.