How to set up alert notifications about integration issues for both QA and Production environments

Introduction

Notifications in ONEiO are used to inform the customer about issues in their integration. Either temporary or permanent issues can be the cause and can be set independently from each other. Furthermore, the configuration settings of the environment and notifications can be selected and adjusted accordingly.

Setup

The notification settings can be found in the subscription settings and can be accessed by the subscription owner only (in the current release).

Step-by-Step

1. Add a new notification recipient by pressing the "Add Recipient" button on the right side of the notification screen.
2. Fill in the recipient email address for the mailbox you wish to receive your notifications.
3. Choose the notification settings for the environment in question.
   1. Production Environment
   2. QA Environment
4. Choose the type of Notification you wish to receive per environment
   1. Warnings
   2. Errors
5. Save you selection by pressing the "Confirm" button

After saving your selection you are presented with the following UI:

The indicator (pop-up) behind the email address shows the current status of the verification process.

• Green: The email address has been verified.
• Yellow: The email address is pending verification. This will expire in 7 days.
• Red: The email verification has expired. You can resend the verification link in the UI be clicking the edit icon  on the right side and pressing "Resend"

Notification Types

ONEiO has two types of notifications to inform customers about integration issues - warnings and errors.

Warnings

• These are defined as temporary issues that can be solved by user intervention, also known as Recoverable Errors.
  
  
• These include for example:
  • Endpoint timeouts
  • Authentication errors
  • General connection problems.

A Warning is also triggered if a message has been in "Pending" state for longer the 5 mins. Only one alert is sent for this warning, even if the message is being retried for longer periods.

Errors

These are defined as problems that can't be resolved by user intervention.

These include but are not limited to:

• Unrecoverable HTTP error codes, defined in the endpoint configuration.
• Invalid response from the target system, defined by the HTTP success codes in the endpoint configuration.
• Invalid response from the target system, defined by the Response success value. These are only used when the target system cannot produce an HTTP success code.

Here is an example from ServiceNow for Unrecoverable HTTP error codes.

And an example for HTTP Success codes, also from ServiceNow.

Alerts

All Alert notifications will be sent from the same email address and follow the same structure. This makes it possible to consume alert notifications and process them further if needed.