Sign in
Channel

Update a channel

Updates a notification channel.

patch/notification/channel/{id}

Path parameters

idstring required

The ID of the channel to update.

Request body

nrnstring

The NRN of the resource (including children resources) where the action will apply.

descriptionstring

An optional description for the notification channel.

sourcestring[]

A list of sources that the notification channel will listen to. Each source represents a specific type of notification.

type'slack' | 'http' | 'github' | 'gitlab' | 'azure' | 'agent'

The type of notification channel.

filtersobject

A flexible object that uses MongoDB query syntax to define criteria for filtering notifications.

Note: See Notification filters for more info.

Example request

{
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "description": "My Slack channel for approval notifications",
  "source": [
    "approval"
  ],
  "type": "slack",
  "configuration": {
    "channels": [
      "my-organization-private-channel"
    ]
  },
  "filters": {
    "action": "deployment:create"
  }
}

Response

The operation was successful.

idinteger required

The unique ID for the notification channel.

nrnstring required

The NRN of the resource (including children resources) where the action will apply.

descriptionstring

An optional description for the notification channel.

sourcestring[]

A list of sources that the notification channel will listen to. Each source represents a specific type of notification.

type'slack' | 'http' | 'github' | 'gitlab' | 'azure' | 'agent' required

The type of notification channel.

filtersobject

A flexible object that uses MongoDB query syntax to define criteria for filtering notifications.

Note: See Notification filters for more info.

Example response

{
  "id": 789,
  "nrn": "organization=1:account=2:namespace=3:application=4",
  "description": "My channel for approval notifications",
  "source": [
    "approval"
  ],
  "type": "slack",
  "configuration": {
    "channels": [
      "my-organization-private-channel"
    ]
  },
  "filters": {
    "action": "deployment:create"
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.