Notifications

Setting Up Email Notifications

You can configure email notifications for any folder that you have access to within the site.

Web UI

1. Navigate into the folder you wish to add a notification for.
2. Click the Email notifications button
3. Fill out the form and click Create Notification

API

The Notifications API will allow you to create, update, or delete notifications.

CLI

Use the following command to create an email notification using the CLI application (replace <FOLDER> with the folder path and <USERNAME> with your own username):

files-cli notifications create <FOLDER> --username <USERNAME>

Notification Options

Every email notification must have three settings associated with it:

• The user or group who will receive the emails
• The path that is being monitored for activity
• The frequency those mails will be sent

In addition, there are several options you can enable. Within the web interface, look for an "Advanced" link to display the fields for these options.

• Include my own activity / Include each user's own activity - The label for this field will change, depending on whether you are editing a notification for yourself or for another user or group. When this option is checked, then the user's activity will generate email notifications. Because this can be a very noisy option, by default it is left unchecked.
• Include subfolders - If this option is checked, making changes in subfolders of this folder will also trigger notifications.
• What file actions trigger this notification - The checkboxes here indicate the types of activity that will cause an email to be sent. By default, only uploading files will cause an email notification.
• What files trigger this notification - With this option, you can specify filenames or wildcards, (such as *.csv) to limit when an email notification is sent. If you do not add any filename patterns, then any file can trigger the email notification.
• Include activity from share bundle recipients - Check this box you would like actions performed via share links and inboxes to generate email notifications.
• Custom message - Any message entered in this setting will be included in every notification email.

Adding Notifications for Other Users

Users with Admin access to the site or to a folder can configure notifications for other users.

Web UI

1. Navigate into the folder you wish to add a notification for.
2. Click the Folder settings button
3. Locate the Email notifications section of the folder settings panel
4. Click the Add new notification button
5. Fill out the form and click Create Notification

API

The Notifications API will allow you to create, update, or delete notifications.

CLI

Use the following command to create an email notification using the CLI application (replace <FOLDER> with the folder path and <USERNAME> with the username of the person who will receive notifications):

files-cli notifications create <FOLDER> --username <USERNAME>

Deleting Notifications

Web UI

1. Navigate into the folder you wish to disable a notification for.
2. Click the Folder settings button
3. Locate the Email notifications section of the folder settings panel
4. Cilck the Delete button that appears on the Actions column for the desired username.
5. Confirm the deletion.

Email Preferences Page

Each notification email includes a link at the bottom to "Update your mail preferences or unsubscribe from these e-mails". Clicking this link takes you to a page that lists all of your currently activity notifications. You can disable individual emails or use the Permanent Removal Option to opt out of all future emails for all notifications.

API

The Notifications API will allow you to create, update, or delete notifications.

CLI

Use the following command to create an email notification using the CLI application. Replace <NOTIFICATION ID> with the unique ID for your notification (you may need to use the files-cli notifications list command to find the notification ID):

files-cli notifications delete --id <NOTIFICATION ID>

Permanently Opting Out of Email Notifications

Each notification email includes a link at the bottom to "Update your mail preferences or unsubscribe from these e-mails". Clicking this link takes you to a page that lists all of your currently activity notifications. You can disable individual emails or use the Permanent Removal Option to opt out of all future emails for all notifications.

Clicking the Don't email me anything, ever again button is a permanent step, and cannot be undone, even by our support staff.

What To Do If Notifications Aren't Being Received

First, verify that the user hasn't unsubscribed or had mail bounce. Go to Settings > Users > [username] > General > Email notifications (or as a non-administrator you can view your own user at My account > Email notifications).

The Status column indicates whether the user is receiving notifications. If they had unsubscribed, the status would indicate "Unsubscribed".

Also, ensure that the User has an E-Mail address set. Some users have an email address as their username yet leave the email field blank. You can add this info by heading to Settings > Users and clicking on a username. Then click the edit button on the first section of the user info, to the right of the avatar to view the E-Mail address form.