Search

InterAction® Administrator Answer Center

Setting Up Email Notifications

  • Updated

You can configure InterAction to send email notifications when API-related errors occur. By default this is turned off, but you may want to use this if you are troubleshooting an issue.

You can either use the email configuration information setup for normal InterAction actions (see Setting Up Email Messaging) or use a different email address.

You can also configure the API to exclude certain errors.

  • Setting Up Email Notification
  • Excluding Specific Errors from Email Notification

Setting Up Email Notification

You enable email notification in InterAction Administrator.

  1. From the main entity list in InterAction Administrator, double-click InterAction API Configuration.
  2. Choose Notifications.
  3. Select the Enable email notifications for API error messages check box.
  4. If you want to just use the email address specified for normal InterAction notifications, select Use the default e-mail account.

  5. If you want to use a different email address, select Use a specific e-mail account and enter the information in the To, From, and From Display Name fields.

    Use the Test button to verify that you have entered the email information correctly.

  6. To exclude specific errors from triggering notifications, choose Exclude Errors. See Excluding Specific Errors from Email Notification.

Excluding Specific Errors from Email Notification

You can identify particular error codes that should not cause email notifications. This is useful for preventing an excessive number of email messages, especially for errors that don’t indicate an actual problem.

For example, the API generates an error if a user enters the wrong account name and password when logging in to an application. This is usually just a mistake on the part of the user and not something that should trigger an email to an administrator.

You exclude a specific error by providing its error code. A list of possible error codes is available in the .NET API Reference documentation in the API Error Codes topic.

API Error Codes Topic in the .NET API Reference Help File

The .NET API Reference help file is installed when you install the .NET API on a workstation.

Also, the code for a particular error is included in the subject line of the email message sent when the error occurs. Therefore, you can enable email notification and then monitor the email address to which the messages are sent. When you receive notifications for errors that you don’t want to track, note the corresponding error codes and add them to the exclude list.

Finding the Error Code in the Email Message

[A] The error code is shown in the email message. If you start receiving email messages for errors that you don’t want, you can note this number and exclude the error.

Note that the error shown here (102) is excluded out-of-the-box.

To exclude an error:

  1. From the main entity list in InterAction Administrator, double-click InterAction API Configuration.
  2. Choose Notifications.
  3. Make sure email notifications are enabled (select the Enable email notifications for API error messages check box)
  4. Choose Exclude Errors. The dialog box displays the list of error codes already set to be excluded.
  5. Choose New.

  6. Enter the Error Code and a Description.

  7. Choose OK to save the changes.
  8. Choose Close to close the list of excluded errors.