---
id: notification-channel-read
title: "Read a channel"
description: "Read a notification channel by its ID."
sidebar_label: "Read a channel"
hide_title: true
hide_table_of_contents: true
api: eJzdWW1v2zgS/isEscC1he28NL3dFZAD3DS7zV43DRJ3r4ckSGlpbHFDkSpJpdEa/u+HoSiblNXa3evdAfclkSyS88wzLxwOFzQDk2peWq4kTeglsIwwIpXlM54y/JWkOZMSBJnWhFtDzl6N6ICqErT7fJbRhIbj7/z4RAPL6IBaNjc0uaYnzc/0dkBLplkBFjR+WFDJCqAJ5TiaI4qS2ZwOqIaPFdeQ0cTqCgYdqJMcyNkrombE5tCP2CqCIBCvSXMoGE0W1NYlSjNWczmnywGFR1aUAmhycPh8eTugBtJKc1s7bFNgGvS4sjlNrm/xswZTKmnA4GKH+/v4bxPZih/yiRliqjQFY2aVQCypkhakxYmsLIVHvfe7wdmLTahq+jukNiLkumFLaokM4zC37IzPq0aso1kjCssbqDwLluTSwhw07SO1kvxj5bidKf1ZclGRFXPf//DjskGzQXCfhPPL89ZuGoyqdArkCZepqDIu5yTNucg0yNVH85R8ykGDm8HShlYuBEH66ggJVXrOJP/DYT0+SFiaqkra48MEvcyULIXj50lA+/ER+kCEcZsKY0mUe2aCBF92p4v+Wq98FCexstTqgYlopkFcjf4BJKY1qzcREcGNRU49YcTmzH4+MBx5OAUksWpETlma+6lEQ6nBgLSGMGJKSHE6QfG4frhcpNM1bbVA1+MWCtPHJMiqiAZjvOkHnqIHsyrj6OdMgLZusMU4HFALAgqwGp+D5HG7HFDLraPUM7X04bCTH/Yp1W8wI1h6H8Bv33NrSzqgc27zato8CIYP7I9KO5XmGOm3a5wO1bIbrT3Bvgk3mkKagVudTkl4O3OprCsgTg9+iunxtc8Ysxs2GBduClJ6hQS1OEzHU2QlRCmYnSldDFtPQHOG2TiEdE2LehhG9rDU/IFZGKbtrhK6gjPOcrBN5UqL3fzk3eWbIAFFQdqE0hQIRkzsM+gbJtnbK+phpgrG5ShVBb5FCwwRxXJAc2CZ2xB38QQ/GDc4L5p84jb3GfVjBSbGsqC4gynt2aMJfen2NZwwtOoeJF12yHfkrHSoVaUDJSothrWqhq1HAm5GgQY7SFuby8XQdmtxaSwToqkxos3sC5b7mdvX1ZSEc30Bs7ZTUQ/D70OeoT38xvFVYvwcojQJnXVDXJMu0KFRkoZSGW6Vrr9K2HpaJ1U16dQMVQnSqlnVyJiBBpnumBhXw9HD7HaZ6Bgo5pPS9zOhPu1sn3UB5yW0K8TrY4bghivJ5XxUF4J2nHXDN/qMGti0Y4TYBj0MRgQ22naU7YG49nC/PWz38W9gpjdsSkqtcPkRmeTckJRJzBL43X8gWAuhl26EgrejH/fnzBgiiFY/OHx+1LVcD6+hcD8nohI32O1UhgG4mxJj3LLJK3h4W5ovx6/b3Nvw9XD/hIxeklbLt+uiCF6C4BLudq7h1waJJfqFIpFI8TdIEdsFefeKHSC2U8xuQO4mLx1aUIueMA1cpynJtnsOK/ndPeyYjMcXZ+Qe6lUZ5uq9WOvxeDweIbwXf/3+hx/32TTNYNZ9v5iY46YsLAoms+1lwCv3NnWlPpaGbtoaQlOXwCOklXVWiHXMmO09YfYVnc3KSDTBB5APXCtZoJAHpjmbCjCbEtIiwym7sRgJaYoaDz0b3ci/kWfPzpWFZ88SgqOxPdB6XTTT5KoSGSkVl7YdMFMiAx2eHx093LRFgRMR7zbM5kOrhiCtrt1iwxkXsLd+J8Oh3ySGOPj4hn53dXr529nJ6d3FePL6hrq+wpqo3ajuZXblWV7THj7653kypkC49Ezoglny4e+n/0zIb+M3704/dDRf0POLu/HJ5Ozt+d3J2/PJ6fsJTehfvlucv52c/XR2Mg6/LF0kMz2vUPC/c25AHVbrePOXzBjI+qzcwXyNEA6oQ3KIR4gvnADb0xv6Fp7JPu+I7clwHdIx7SeV1iCtqAduiJKiJqYqS6Ut+NnckA8oqEtyI93hNCAgtUrv5h7t6E6u6ZowcjsqVMpEI22VB92RdIknphkXdqdDx5jMBDzyqYD23OkaDJUBQ35Vcq5evSQfK9A1MbW07BENl8EMgzLV3ILmzMFuBGKTJzoEjW5kzO8VALk+D4+0Hurtk71MpWYvmr7nPz51Mgql0ednqnMEahpHNKEZlELVSFCSamAWYn7Cpdum5dKNOHr/frPbdyI4Bh5orTRZNQdJVrlMxuUDEzwjXJaVOxgU3BjUf93G+GYtQWOZrcyJyrDx4PDQAS3AGDaHzX5gMHp7TfF6MrkgzQySqizoEqEu6IyrTlEa8vEERvPRgBzt7+OfA/zzHP8cPY2Mc7S/7/a+bIf9YkwKluZcwhB7u5jrvCyHy7llyizM8fzpd0fM1aDJjHFR6U5NMmXZnT8yu6TtaNsBxFRzmA1IXhVMrpGE7UCfPhpwLiV4Nm7oS5aRy0boDcUf3knmj8yQ3dCYnHA0Qmwtuh1klvFVm9IyLgxhU1XZNaxYzmTdPXBd64IJ3DMgI45daRmXkK1cOvTg5bKJkBd9EXLV0N+NEC4z5+dyTpgk3JgKE2lTS16cEcMz+D8LDRMS4Z3hBYbGi/1D/PM8NvyL/11UoLJaMnHXDLprKPuvxceZF0+865zimCZSrpq6i7yT7IFxgatuBEzv9P9o6IwlqSQ8lpDi/t+opNIUq4RsRC4EMAPE6pqwOeOSCGZBt1HjcNlc4XF3Du48gvdfCY02uT3f6dxb8Gzpu+btBVrcq2MlH4UdVuzY0fBi6wpDpvH08HprxYlvarvIcinSDaID//CTqyNpQn/5x8TVgLjX4nTE09B3MNof7dP1lhru5O5Aq4wtmItff/nnLx7bdu7GjcwqC+x+Rem1sfBo90rhD4O+59swfB3t9ZhrVuITnmFeyJWxOG6xmDID77RYLvFnV+rgheCAtgW3M0TGDT5nNJkxYbpXlqEWTy59dnpKvu4is1ertvCWWHY/MFHhGx1Qd4zFmz9X7TUNWge0+TBOUyhtMGUjwaLbrJzz59OJu6SJnKXjHOFNQwxnsWhGTLABvFyu0PmGMFbu/wL4wJp1
sidebar_class_name: "get api-method"
info_path: docs/api/notification
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Read a channel"}
>
</Heading>

<MethodEndpoint
  method={"get"}
  path={"/notification/channel/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Read a notification channel by its ID.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"description":"The ID of the notification channel to read.","schema":{"type":"string"},"example":123}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={undefined}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"200":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","nrn","type","configuration"],"properties":{"id":{"type":"integer","description":"The unique ID for the notification channel.","example":789},"nrn":{"type":"string","description":"The NRN of the resource (including children resources) where the action will apply.","example":"organization=1:account=2:namespace=3:application=4"},"description":{"type":"string","description":"An optional description for the notification channel.","example":"My channel for approval notifications"},"source":{"type":"array","description":"A list of sources that the notification channel will listen to. Each source represents a specific type of notification.","example":["approval"],"items":{"type":"string","enum":["approval","service","audit","alert","entity","telemetry","parameters"]},"title":"source"},"type":{"type":"string","description":"The type of notification channel.","example":"slack","enum":["slack","http","github","gitlab","azure","agent"],"title":"type"},"configuration":{"type":"object","description":"The configuration object for the notification channel.","oneOf":[{"type":"object","properties":{"channels":{"type":"array","items":{"type":"string"},"description":"An array of Slack channels.","example":["nullplatform-approvals"]}},"example":{"channels":["my-organization-private-channel"]},"title":"slack"},{"type":"object","properties":{"url":{"type":"string","description":"The URL where the notifications will be sent.","example":"https://my-domain.com/my-notifications-url"},"headers":{"type":"object","description":"The headers to be sent with the request.","example":{"Authorization":"Bearer the-token"}}},"example":{"url":"https://yourdomain.com/url-you-configured","headers":{"Authorization":"Bearer the-token"}},"title":"http"},{"type":"object","properties":{"installation_id":{"type":"string","description":"The GitHub installation ID.","example":"my-installation-id"},"account":{"type":"string","description":"The GitHub account or organization.","example":"my-github-org"},"repository":{"type":"string","description":"The GitHub repository.","example":"services-opentofu"},"reference":{"type":"string","description":"The reference to the GitHub repository.","example":"main"},"workflow_id":{"type":"string","description":"The ID of the GitHub workflow.","example":"provisioning.yml"}},"example":{"installation_id":"my-installation-id","account":"my-github-org","repository":"services-opentofu","reference":"main","workflow_id":"provisioning.yml"},"title":"github"},{"type":"object","properties":{"reference":{"type":"string","description":"The reference to the GitLab project. This can be the project name or ID.","example":"main"},"project_id":{"type":"string","description":"The ID of the GitLab project.","example":"1234"}},"example":{"reference":"main","project_id":"1234"},"title":"gitlab"},{"type":"object","properties":{"organization":{"type":"string","description":"The Azure DevOps organization.","example":"my-azure-org"},"project":{"type":"string","description":"The Azure DevOps project.","example":"my-azure-project"},"pipeline_id":{"type":"integer","description":"The ID of the Azure DevOps pipeline.","example":1234},"reference":{"type":"string","description":"The reference to the Azure DevOps pipeline.","example":"main"}},"example":{"organization":"my-azure-org","project":"my-azure-project","pipeline_id":1234,"reference":"main"},"title":"azure"},{"type":"object","properties":{"api_key":{"type":"string","description":"The API key for the agent.","example":"AAAA.1234567890abcdef1234567890abcdefPTs="},"command":{"type":"object","description":"Describes the command the agent will execute.","properties":{"data":{"type":"object","description":"The command line and environment variables.","properties":{"cmdline":{"type":"string","description":"The command line to be executed.\n> **Note**: The path to the command line should point to the folder where the agent is installed.\n","example":"path-to-entrypoint-file/entrypoint --service-path=\"$SERVICE_PATH\""},"environment":{"type":"object","description":"The environment variables for the command.\n> **Note**: The environment variables should be in the format `KEY: VALUE`.\n","example":{"NP_ACTION_CONTEXT":"'${NOTIFICATION_CONTEXT}"}},"arguments":{"type":"array","items":{"type":"string"},"description":"The arguments to be passed to the command line.\n","example":["arg1","arg2"]}}},"type":{"type":"string","enum":["exec"],"description":"The command type of the agent.\n> **Note**: Currently, the only supported type is `exec`.\n","example":"exec"}}},"selector":{"type":"object","description":"The selector for the agent.\n","example":{"environment":"local"}}},"title":"agent"}]},"filters":{"type":"object","description":"A flexible object that uses MongoDB query syntax to define criteria for filtering notifications.\n\n> **Note**: See [Notification filters](/docs/notifications/filters) for more info.","example":{"action":"deployment:create"}}},"title":"notificationChannel"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>