notifications

Send a test alert through a single notification channel (admin/superadmin)

Changed on
post/notifications/test

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/notifications/test
  • Auth
    HTTP bearer

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "notificationName": "Ops on-call email",
  "type": "email",
  "address": "alerts@example.com"
}

Response

Send result

successboolean required
msgstring required

Changes

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      removed the true enum value from the response property for the response status