Overview

The Notification Services is a feature that provides information and data about the system's operation to external systems. This data includes attributes values coming from the managed devices as well as system alerts for events like setting changes, new users and product configuration changes. Users can choose from a variety of delivery methods such as webhooks and websockets depending on their applications requirements. They can also choose to have a full message with header information delivered or just the data portion in the notification.

A primary use case for Notifications is delivery of reported data from the managed device to the customer's cloud system for their specific business logic and analytics. The Notification feature supports guaranteed delivery of the notifications as well as the ability to query historical notifications.

A list of the available notifications and their delivery format is included below.

How-To

Using Notifications requires three steps:

1. Creating a notification template describing the type of notification to be delivered
2. Setting the preference for where the notification will be delivered (for example the webhook url)
3. Subscribing to the specific notification templates the user wants to receive

Step 1: Create the notification template

• Creating the notification template is the primary step in defining what types of notifications the customer wants to receive for a specific product line.
• The steps for creating a template are detailed in the Portal Guide – Configure Product/Endpoint - Notifications

Step 2: Set preference for notification delivery

• Next, the customer needs to define the delivery preferences.
  • This includes setting the notification delivery endpoint
• The steps for setting the preference are detailed in the Portal Guide – Manage Preferences

Step 3: Subscribe to the notifications

• Each user will need to subscribe to the notifications they want to receive unless they are set 
  • Note: users are automatically subscribed to notifications that were created for all users.
• The steps for subscribing to notifications are detailed in the Portal Guide –  View Notifications List