Using Notification Templates
Email notifications are sent automatically to users based on events in the store. To send them, you must first create a Notification Template. Notification templates under a channel define the sender, recipient, trigger, and content of an email notification.
The preferred way to set up notifications is by creating a notification template and then using it in an object action. See Notification Template and Defining Object Actions for more information. The following instructions specify how to create a notification template at the channel level.
To use notifications, first configure mail settings for your Liferay system. See Configuring Mail for more information.
Event Triggers
Every notification template has a type that determines the channel event that triggers the notification. Commerce includes the following event triggers for notification templates.
| Notification Type | Event |
|---|---|
| Order Placed | An order is placed in the channel. |
| Order Processing | The order is in process. |
| Order Awaiting Shipment | The order is ready for shipping. |
| Order Partially Shipped | Order items are shipped separately. |
| Order Shipped | The order has shipped. |
| Order Completed | The order has been delivered and marked as complete. |
| Subscription Renewed | A subscription is renewed. |
| Subscription Activated | A subscription is activated. |
| Subscription Suspended | A subscription is suspended, pending review or action by the store. |
| Subscription Canceled | A subscription is cancelled. |
Creating a Notification Template
-
Open the Global Menu (
) and navigate to Commerce → Channels. -
Select a channel and go to Notification Templates.
-
Click Add (
). -
Enter a name and description for the template.
-
Select an event type to determine which channel events trigger the notification. Each template can only have one trigger.
-
Toggle the switch to enable the template.
-
Under Email Settings, enter the sender and recipients for the notification.
You can use template variables to populate these fields automatically using data from the triggering event. See Notification Template Variables Reference Guide for more information. If required, you can also specify the actual email addresses to send the notification to.
-
In the Email Content section, enter a subject and body for the email.
You can use template variables to populate these fields automatically using data from the triggering event. See Notification Template Variables Reference Guide for more information.
-
Click Save.
While enabled, the notification template automatically sends emails when triggered. The Notification Queue tab displays all triggered notifications with its sender, recipients, event type, status, and priority.
Viewing Email Notifications of an Order
Email notifications related to an order are tracked. To view them, open the Global Menu () and navigate to Commerce → Orders. Select an order and click the Emails tab. See Order Information to learn more.
