Notifications

Introduction

Notifications can be accessed by clicking the Notifications tab on the Settings screen.

Click 'Notifications' Tab

Under Notifications, you can access:

  • Email Notifications

Under General (Settings), you can access:

  • Configuration
  • Master Password Configuration
  • Storage Settings

Under License, you can access:

  • License

Under Troubleshooting, you can access:

  • Logging

Under Extensions, you can access:

  • Extensions
  • Key-Value Stores

Under Advanced, you can access:

  • Flow External Workflow Changes
  • Move Routes Between Integrations
  • Import Artifact Pair Information
  • Upgrade Backup Files

Email Notifications

To facilitate troubleshooting, you can configure automated email notifications for new errors and issues encountered in Tasktop. 

Emails will contain a count of new issues and errors (excluding ignored errors) since the last email notification, and a link to the Activity screen to view the errors/issues. Emails will be sent only if a new error or issue occurs. 

Email Sample

Configuring Email Notifications

To configure email notifications click +Add Email Server.

Click 'Add Email Server'

This will bring you to the Email Notifications screen.

Email Notifications Screen

The form requires that the following fields be filled out:

Basic Details

  • To Email Address: The email address that will receive the notifications.  This field is limited to one email address.
  • From Email Address: The email address listed in the 'sender address' (or 'from') field of notification emails sent by Tasktop.  In many cases, this will match the email whose settings are configured in the 'Email Server Settings' section below, though a different email (such as no-reply@email.com) can be configured here.  If a user were to hit  'reply' on an email notification, this is the email the reply would be sent to.
  • Subject Prefix (optional): The prefix appended to the subject line of the Error Notification emails.  This defaults to [Tasktop] but can be edited if needed.  This can help users filter email notifications from Tasktop based on prefix.
  • Tasktop Server URL: The URL used to access your instance of Tasktop.  This is used to construct links to errors and issues in the notification emails.
  • Notification Frequency: The frequency of email notifications.  Emails will contain a count of new issues and errors since the last notification and will only send if a new error or issue has occurred since the prior email.

Email Server Settings

These are the email server settings that allow Tasktop to send notifications.

  • Username (optional): Username for the authenticated SMTP server.
  • Password (optional): Password for the authenticated SMTP server.
  • SMTP Server: The SMTP host name of your mail server. 
  • SMTP Port: The SMTP Port number to use.
    • If Protocol = SMTP, the value for this will typically be 25.  
    • If Protocol = SMTPS, the value for this will typically be 465.
    • If Protocol = SMTP_STARTTLS, the value for this will typically be 587, but can also be port 25.
  • Connection Timeout: Specifies the maximum period, in seconds, that establishing an email server connection is permitted to take. This defaults to 60 seconds, which should cover most scenarios.
  • Protocol
    • SMTP: Basic unencrypted SMTP Protocol.  
    • SMTPS: A more advanced, encrypted SMTP Protocol (SMTP Secure), which will perform server certificate validation.
    • SMTP_STARTTLS: A modern protocol that wraps the unencrypted SMTP protocol in TLS (formerly known as SSL encryption), and will perform server certificate validation.  This will attempt the STARTTLS wrapper, but if it is not supported by the server, the client will fall back to basic SMTP.

(lightbulb) Note: Google email users should select SMTP_STARTTLS.

Here's an example of a filled in form:

Completed Email Notifications Form

You can test your email server settings by clicking Test Connection.

Click 'Test Connection'

Or, send a test email by clicking Send Test Email.

Click 'Send Test Email'

Once settings are filled in and the connection has been tested, click Save to save your settings.

Click 'Save'

Click Turn On Notifications to enable email notifications.

Turn On Notifications

Once saved, you can turn email notifications on or off and delete the notification settings from the Notifications screen. You can also click Configure Notification Settings to modify your existing settings:

Update Email Notification Settings from Notifications Screen

(lightbulb) Note: If an email notification fails, an issue will be surfaced on the Activity screen in Tasktop.

To configure email notifications, click Configure Notification Settings.

Click 'Configure Notification Settings'

This will bring you to the Email Notifications screen.

Email Notifications Screen

The form requires that the following fields be filled out:

Basic Details

  • To Email Address: The email address that will receive the notifications. This field is limited to one email address.
  • Subject Prefix (optional): The prefix appended to the subject line of the Error Notification emails. This defaults to [Tasktop] but can be edited if needed. This can help users filter email notifications from Tasktop based on prefix.
  • Notification Frequency: The frequency of email notifications. Emails will contain a count of new issues and errors since the last notification and will only send if a new error or issue has occurred since the prior email.

Here's an example of a filled in form:

Completed Email Notifications Form

You can test your email server settings by clicking Test Connection.

Click 'Test Connection'

Or, send a test email by clicking the Send Test Email button.

Click 'Send Test Email'

Once settings are filled in and the connection has been tested, click Save to save your settings.

Click 'Save'

Click Turn On Notifications to enable email notifications. 

Once saved, you can turn email notifications on or off and delete the notification settings from the Notifications screen.

You can also click Configure Notification Settings to modify your existing settings:

(lightbulb) Note: If an email notification fails, an issue will be surfaced on the Activity screen in Tasktop.