Overview

Adding email recipients allows you to set global notifications that will trigger email messages whenever a subscribed event occurs. Because the notifications set here are global, they are not linked to a user, so notifications are not restricted to user-defined accounts, jobs, etc. This means you can send notifications to a user who does not have a DryvIQ account. For example, your Office Administrator or Billing Department may not have user accounts in DryvIQ, but you can add the corresponding email address to receive notifications regarding your DryvIQ license expiration so they can ensure proper renewal and payment as needed.

GET Current Notification Details (Global Notifications)

This GET lists all details for the current global notification configuration.

GET {{url}}v1/notifications/

Example Response

{
   "status": 200,
   "meta": {
       "links": {
           "self": {
               "href": "https://localhost:9090/v1/notifications/"
           }
       },
       "offset": 0,
       "limit": 100,
       "has_more": false
   },
   "type": "notifications",
   "notifications": [
       {
           "id": "d8bfbb536df94a8089fab3d31654ebfa",
           "recipient": "person@company.com",
           "handler": "email",
           "notification_types": [
               "job-completed"
           ],
           "kind": "email",
           "type": "notification"
       }
   ]
}

List Available Categories Types

This GET lists all the available notification categories.

GET {{url}}v1/notifications/types

Example Response

{
   "status": 200,
   "type": "notification_types",
   "notification_types": [
       {
           "id": "connection-failed",
           "name": "Connection failed",
           "description": "Receive a notification whenever a connection fails to open."
       },
       {
           "id": "product-upgrade-available",
           "name": "Upgrade available",
           "description": "Receive a notification when a new version of the software is available."
       },
       {
           "id": "license-expired",
           "name": "License has expired",
           "description": "Receive a notification when your license has expired."
       },
       {
           "id": "license-expiration-warning",
           "name": "License expiry approaching",
           "description": "Receive a notification when your license will expire soon."
       },
       {
           "id": "job-failed",
           "name": "Job failed",
           "description": "Receive a notification whenever a job fails."
       },
       {
           "id": "job-completed",
           "name": "Job completed",
           "description": "Receive a notification whenever a job meets its stop policy."
       }
   ]
}

Add New Email Recipient | Global Notifications

This POST adds a new email recipient to the global notifications configuration.

POST {{url}}v1/notifications/

Example Request Body

{
   "handler": "email",
   "kind": "email",
   "notification_types": [
       "job-completed",
       "job-failed",
       "connection-failed",
       "product-upgrade-available",
       "license-expired",
       "license-expiration-warning"
   ],
   "recipient": "person@company.com",
   "type": "notification"
}