Account5

Action36

Action Item12

Action Item Category5

Action Item Comment2

Agent3

Announcements6

API keys5

Application4

Approval6

Artifact7

Asset4

Authentication1

Build4

Catalog instance (multiple keys)3

Catalog instance (single key)4

Catalog specification5

Category2

Channel5

Checklist6

Custom domain5

Deployment4

Deployment group4

Deployment strategy5

Dimension5

Dimension value1

Dimension Value4

Entity hook8

Event3

Inbox rules12

Link12

Log config4

Log specification5

Log template4

Namespace5

NRN5

Organization2

Package10

Parameter11

Personal access tokens5

Policy5

Provider6

Provider Specification5

Query1

Release4

Report versions8

Reports6

Role and grant5

Runtime Configuration5

Scope10

Scope type5

Service15

Suggestion8

Technology template5

User4

Workflow aliases7

Workflow definitions7

Workflow engine1

Workflow executions10

Workflow plugins2

Workflow revisions2

Workflow secrets and variables5

Workflow signals3

Workflow triggers1

Channel

Read a channel

Changed on Nov 2, 2026

Read a notification channel by its ID.

get/notification/channel/{id}

Request

Base URL
https://api.nullplatform.com
URL
https://api.nullplatform.com/notification/channel/{id}
Auth
HTTP bearer

Path parameters

idinteger required

The ID of the notification channel to read.

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.

status'active' | 'inactive'

Whether the channel receives notifications. Only active channels are matched when a notification is sent. New channels are created as active.

created_atstring date-time

The ISO 8601 UTC timestamp for the creation of this channel.

updated_atstring date-time

The ISO 8601 UTC timestamp for the last update to this channel.

sourcestring[]

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

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",
  "status": "active",
  "created_at": "2026-01-19T12:34:56Z",
  "updated_at": "2026-01-19T12:34:56Z",
  "source": [
    "approval"
  ],
  "type": "slack",
  "configuration": {
    "channels": [
      "my-organization-private-channel"
    ]
  },
  "filters": {
    "action": "deployment:create"
  }
}

Changes

Nov 2, 2026d3f66bc633d4 Revision changes
- breaking
  the response property ///// became optional for the status
Oct 15, 2026728d4df70ca1 Revision changes
- breaking
  for the path request parameter id, the type changed from string to integer
- breaking
  the response property became optional for the status
- breaking
  the response property became optional for the status
- breaking
  added to the response property oneOf list for the response status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  added the new bitbucket enum value to the response property for the response status
- warning
  added the new checklist enum value to the / response property for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  media type application/json was changed to a more specific media type application/problem+json for the response status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ////// became required for the status
- info
  the response property /////// became required for the status
- info
  the response property ////// became required for the status
- info
  the response property ///// became required for the status
- info
  the response property ///// became required for the status
- info
  response property message deprecated
- info
  response property message deprecated
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status

Operation history