list_notifications()

The Settings API

The list_notifications() function shows all active notifications. An active notification is a notification for which there are one or more recipients are set.

Method

list_notifications

Input

List notifications request v1

https://api.nextpertise.nl/schemas/settings/list_notifications_request_v1.json

Fetches a list of all assigned notifications.

type

object

properties

Output

List notifications reply v1

https://api.nextpertise.nl/schemas/settings/list_notifications_reply_v1.json

Fetches a list of all assigned notifications.

type

object

properties

  • notifications

List of all assigned notifications.

type

array

items

type

object

properties

  • notification

Notification name

type

string

  • kind

Notification transport method. Currently only email is supported.

type

string

enum

EMAIL

  • address

Destination address for kind transport method.

type

string

additionalProperties

False

Example

Request

curl -H <key> https://api.nextpertise.nl/settings/v1 -d'{
    "jsonrpc": "2.0",
    "id": 1,
    "method": "list_notifications",
}' | jq .

Reply

{
    "jsonrpc": "2.0",
    "id": 1,
    "result": {
        "notifications": [
            {
                "notification": "error message",
                "kind": "EMAIL",
                "address": "some@email.address"
            }
        ]
    }
}