Request list of notification channels

v1.0.0

🚀 Since v4.20.0

Description:

Retrieve a list of configured notification channels.

Precondition:

Authenticated user.

Postcondition:

List of notification channels is returned.

Further Information:

None.

Input

{
  "type": "object",
  "properties": {
    "X-Sds-Auth-Token": {
      "type": "string"
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "List of notification channels",
  "required": [
    "items"
  ],
  "properties": {
    "items": {
      "type": "array",
      "description": "List of notification channels",
      "items": {
        "type": "object",
        "description": "Notification channel information",
        "required": [
          "frequency",
          "id",
          "isEnabled",
          "name",
          "type"
        ],
        "properties": {
          "frequency": {
            "type": "integer",
            "format": "int64",
            "description": "Channel frequency (aggregation window size in minutes)"
          },
          "id": {
            "type": "integer",
            "format": "int32",
            "description": "Channel ID"
          },
          "isEnabled": {
            "type": "boolean",
            "description": "Determines whether channel is enabled"
          },
          "name": {
            "type": "string",
            "description": "Name"
          },
          "type": {
            "type": "string",
            "description": "Channel type (only `EMAIL` available at the moment)"
          }
        }
      }
    }
  }
}