Versions Compared

Old Version 3

changes.mady.by.user Andrea Harvey

Saved on

compared with

New Version 4

changes.mady.by.user Andrea Harvey

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

On This Page

Table of Contents

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.

Code Block
POST {{url}}v1/notifications/test

Example Request Body

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

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.

Code Block
GET {{url}}v1/notifications/types

Example Response

Code Block
{
    "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."
        }
    ]
}