Send a Test Email Notification Using REST API



On This Page

Overview

You can trigger a test email notification using REST API to review what recipients will see when an email notification is delivered. Sending a test notification is not dependent on having configured a notification policy. Use the following JSON to configure your REST API message.

 

Send a Test Notification

This request will not persist; it is a one-time use request.

POST {{url}}v1/notifications/test

 

Example Request Body

{ "handler":"email", "notification":"connection-failed", "targets":[ "email@somecompany.com", "person@somecompany.com" ] }

 

Name

Value

Name

Value

Handler

This string identifies the handler that should generate the test notification message. In this test, the value should be “email.”

 

Notification

This string identifies the notification category that should be used for the message. Valid notification values are listed below.

  • “connection-failed”

  • “product-upgrade-available”

  • “license-expired”

  • “license-expiration-warning”

  • “job-failed”

  • “job-completed”

Targets

This string identifies the recipient information that should be used for the notification. In this test, include the email address to which you want to send the test message. When including multiple email addresses, use a comma to separate each address, but do not add a comma after the last email address.

 

List Available Categories Types

The following GET list all the available notification categories.

GET {{url}}v1/notifications/types

 

Example Response

 

 

 

 

 

 

DryvIQ Migrate Version: 5.9.2
Release Date: December 17, 2024