Feed Health Email Notifications

Feed Health Notifications allow the ThreatQ Platform (TQ) to send you, and other designated users, email notifications when a Configuration Driven Feed (CDF) or Configuration Driven Workflow (CDW) encounters an issue.

The emails, sent to users designated on the Notification Settings page, will contain useful information such as connection information, data ingested, and an ingestion summary.

Configuring Mail Server

You must enter your mail server information on the Mail Server Configuration tab before enabling Feed Health Notifications.

In the event that you have completed the mail server configuration and are still not receiving emails, your email provider may have marked the activity as suspicious. Some services, such as Gmail, will require you to confirm the activity, via an email message, before allowing the ThreatQ application to continue to use the server to send emails. A common symptom found in the error log is that you will receive an “incorrect password” error. If you are certain that the password you provided is correct, your mail service is likely blocking the service and requires your confirmation to proceed.

To Configure Mail Server:

1. Click on the System Settings  gear icon and select the Notification Settings option.

   The Notification Settings page loads.
   

2. Click on the Mail Server Configuration tab.

   The Mail Server Configuration page loads.
   

3. Complete the following fields:

   Field	Description
   Server Name	The address of your mail server.
   SSL Method	The SSL method used. There are three options: SSL TLS None
   Port #	The mail server port.
   User name	The mail server account username.
   Password	The mail server account password.

4. Enter an email in the Test Email field and click Save and Send Test Email to confirm that the settings are correct - this is optional. You will receive a setup confirmation email.
   
5. If you did not use the Save and Send Test Email option, click on Save Changes to save your settings.

Enabling Feed Health Notifications

There are two different types of Feed Health Notifications that can be enabled on this page: In-App and Email. While you can enter the email address for a user to receive Email Notifications, only users with administrator and maintenance roles will receive In-App Notifications. 

If using Email Notifications, the Mail Server Configuration tab must completed before you enable the feature.

In the event that you have completed the mail server configuration and are still not receiving emails, your email provider may have marked the activity as suspicious. Some services, such as Gmail, will require you to confirm the activity, via an email message, before allowing the ThreatQ application to continue to use the server to send emails. A common symptom found in the error log is that you will receive an “incorrect password” error. If you are certain that the password you provided is correct, your mail service is likely blocking the service and requires your confirmation to proceed.

To Enable Feed Health Notifications:

1. Click on the System Settings  gear icon and select the Notification Settings option.

   The Notification Settings page loads.
   

2. Perform the following steps to enable email and in-app notifications:
   • Enable In-App Feed Health NotificationsEnable In-App Feed Health Notifications
     1. Click on the Enable toggle switch for In App Notifications.
   • Enable Feed Health Email NotificationsEnable Feed Health Email Notifications
     1. Enter an email address in the account field and press the <Enter> or <Return> key.
        
     2. Click on the Enable toggle switch for Email Notifications.
3. Use the toggle switch next to each feed to enable/disable notifications for individual feeds.
   

   You can also enable/disable individual CDF feed notifications by clicking on the feed under Integrations and checking/unchecking the notifications checkbox.