notifications

Update notification channel

Changed on

Replaces a notification channel. Existing secret values are preserved when omitted. Developer, manager, or admin only.

put/notification-channels/{channelId}

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

channelIdstring required

Query parameters

remoteNodestring

name of the remote node

Request body

namestring required

Human-readable channel name

type'email' | 'webhook' | 'slack' | 'telegram' | 'teams' | 'command' required

Notification delivery provider

enabledboolean required

Whether this channel can receive notifications

Response

Notification channel updated

idstring required

Stable channel ID

namestring required

Human-readable channel name

type'email' | 'webhook' | 'slack' | 'telegram' | 'teams' | 'command' required

Notification delivery provider

enabledboolean required

Whether this channel can receive notifications

createdAtstring date-time required
updatedAtstring date-time required
updatedBystring

User ID that last updated the channel

Changes

    • warning

      added the new command enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new command enum value to the request property

    • info

      added the optional property to the response with the status

    • warning

      added the new teams enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property /

    • info

      added the new teams enum value to the request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property / to the response with the status