Sign in
Notification Channels

List notification channels

Retrieve a list of all notification channels configured on the server.

get/v1/notification-channels

Response

Notification channels retrieved successfully

namestring

Channel name

descriptionstring

Channel description

driverNamestring

Notification driver name

configurationstring

Driver-specific configuration

driverInitializedboolean

Whether the driver was initialized successfully

needSubjectboolean

Whether the driver requires a subject field

needRecipientboolean

Whether the driver requires a recipient field

errorMessagestring

Last error message

sendStatusinteger

Last send status code

healthCheckStatusboolean

Health check status

lastMessageTimestring

Timestamp of last sent message

messageCountinteger

Total messages sent

failureCountinteger

Total send failures

digestedCountinteger

Total messages absorbed into digest

queueSizeinteger

Current message queue size

providedByChatBotboolean

Whether the channel is provided by a chat bot (such channels cannot be modified, renamed, or deleted)

Changes

Changed in 1 of the 72 revisions of this API.1

  • 2432d610460c1See the full diff
    • ○

      added the optional property items/providedByChatBot to the response with the 200 status

      response-optional-property-added