Notification

You can configure various notifications in your system to remind you of important activities.

1. The completion date of a Task.
2. Expected Delivery Date of a Sales Order.
3. Expected Payment Date.
4. A reminder of follow up.
5. If an Order greater than a particular value is received or sent.
6. Expiry notification for a Contract.
7. Completion/Status change of a Task.

To access notification setup, go to:

Home > Settings > Notification

1. Setting Up An Alert

To set up a Notification:

1. Define what events you want to watch under Send Alert On. Events are:

   1. New: When a new document of the selected type is made.
   2. Save/Submit/Cancel: When a document of the selected type is saved, submitted, or canceled.
   3. Days Before/Days After: Trigger this alert a few days before or after the Reference Date. To set the days, set Days Before or After. This can be useful in reminding you of upcoming due dates or reminding you to follow up on certain leads of quotations.
   4. Value Change: When a particular value in the selected type changes.
   5. Method: Sends notification when a specific method is triggered. Eg: before_insert.
   6. Custom: Send a notification to an Email Account selected.
2. Select the Document Type you want to watch changes on. From Version 16, You can also select child Document Types if Send Alert On is set to Days Beforeor Days After.
3. Set additional Conditions if required.
4. Set the recipients of this alert. The recipient could either be a field of the document or a list of fixed Email Addresses.
5. Compose the message.
6. Save.

1.1 Setting a Subject

You can retrieve the data for a particular field by using doc.[field_name]. To use it in your subject/message, you have to surround it with {% raw %}{{ }}{% endraw %}. These are called Jinja tags. For example, to get the name of a document, you use {% raw %}{{ doc.name }}{% endraw %}. The following example sends an email on saving a Task with the Subject, "TASK#### has been created"

1.2 Setting Conditions

Notifications allow you to set conditions according to the field data in your documents. For example, if you want to receive an Email if a Lead has been saved as "Interested" as it's status, you put doc.status == "Interested" in the conditions textbox. You can also set more complex conditions by combining them with the operator and or or.

The above example will send a Notification when a Task is saved with the status "Open" and the "Expected End Date" for the Task is the date on or before the date on which it was saved on.

1.3 Setting a Message

You can use both Jinja Tags ({% raw %}{{ doc.[field_name] }}{% endraw %}) and HTML tags in the message textbox.

{% raw %}<h3>Order Overdue</h3>

Transaction {{ doc.name }} has exceeded Due Date. Please take necessary action.

{% if comments %} Last comment: {{ comments[-1].comment }} by {{ comments[-1].by }} {% endif %}

<h4>Details</h4>

• Customer: {{ doc.customer }}
• Amount: {{ doc.total_amount }}

{% endraw %}

1.4 Setting a Value after the Alert is Set

Sometimes to make sure that the Notification is not sent multiple times, you can define a custom property (via Customize Form) like "Notification Sent" and then set this property after the alert is sent by setting the Set Property After Alert field.

Then you can use that as a condition in the Condition rules to ensure emails are not sent multiple times

1.5 Example

1. Defining the Criteria
2. Setting the Recipients and Message

2. Slack Notifications

If you prefer to have your notifications sent to a dedicated Slack channel, you can also choose the option "Slack" in the channel options and select the appropriate Slack Webhook URL.

2.1 Slack Webhook URL

A Slack webhook URL is a URL pointing directly to a Slack channel.

To generate webhook URLs, you need to create a new Slack App:

1. Go to https://api.slack.com/slack-apps.
2. Click on "Create a Slack App".
3. Give your App a name and choose the right workspace. Once your app is created, go to the "Incoming Webhooks" section and add a new Webhook to Workspace.
4. Copy the created link, go back to ERPNext and use it to create a new Slack Webhook URL in Integrations > Slack Webhook URL.
5. Select Slack and your Slack channel in the channel and Slack channel fields within your notification

2.2 Message Format

Unlike Email messages, Slack doesn't allow HTML formatting.

Instead, you can use markdown formatting: Slack Documentation

Example: {% raw %} Order Overdue

Transaction {{ doc.name }} has exceeded Due Date. Please take the necessary action.


{% if comments %}
Last comment: {{ comments[-1].comment }} by {{ comments[-1].by }}
{% endif %}

*Details*

• Customer: {{ doc.customer }}
• Amount: {{ doc.grand_total }}
{% endraw %}

3. System Notifications

In Version 12 we introduced System notifications for Assignments, mentions, documents shared, and Energy Points. These notifications show up in the notifications dropdown on the the navigation bar's top right corner.

In Version 13 we have introduced an additional channel to send alerts - System Notifications:

Choosing this channel will send a system notification when a notification is triggered, instead of an Email or a Slack notification.

Clicking on the notification routes to the Notification Log document which contains the configured subject, message as well as the attached file, if Attach Print is set:

If Email/Slack alerts and System Notifications both are required, the main channel can be set as Email or Slack and this option can be checked:

4. WhatsApp

In Version 13 we have introduced an additional channel to send alerts - WhatsApp:

If you prefer to have your notifications sent to a WhatsApp number, you can also choose the option "WhatsApp" in the channel options and select the appropriate Twilio Number. Twilio Numbers can be added to Twilio settings in Frappe. WhatsApp messages can only be sent to numbers which have country codes in them.

4.1 Twilio Settings

In order to configure Twilio settings, you need to first obtain Twilio credentials from your Twilio Account's account settings. You can only add those phone numbers that have been activated in your Twilio Account with WhatsApp access.

4.2 Message Format

WhatsApp allows their users to only send those message templates that are pre-approved by them to your customers. Failure to do so might result in restrictions on you Twilio account.

5. SMS

In Version 13 we have introduced an additional channel to send alerts - SMS:

In order to use this channel, you would need to complete the configuration of SMS Settings.

6. Related Topics

1. SMS Settings
2. Document Follow

7. One-off Reminders

Note: This feature is only available in nightly version as of now.

Since setting up notifications is quite involved process, Frappe Framework also provides a way to setup one-off reminders on documents. Example of such notification would be "Remind me to follow up about this lead in 4 hour"

To set up one-off reminder on document:

1. Open the document on which you want to set a reminder
2. Click on menu (three dots) > "Remind Me"
3. Select time and add a description for yourself and click "Create"
4. System will send you a system notification around the time you've configured with reminder description as subject.