---
id: notification-channel-create
title: "Create a channel"
description: "Create a new notification channel."
sidebar_label: "Create a channel"
hide_title: true
hide_table_of_contents: true
api: eJztW21vG7kR/isEcUCTQJKdxOndCXABRfE1bnO2ESvXFLbhULsjiWcuuSG5tnWC/nsxJFdarjaWlDpp0cofjJX4MjPPzJDzop3RFEyieW65krRL+xqYBcKIhDsileUjnjAcI8mESQmiQ1tU5aDdl8cp7dLqrOswq5u4fWiLWjY2tHtB+36AXrWogaTQ3E5p92JGh8A06F5hJ7R7cTW/alENnwsw9rVKp7Q7o4mSFqTFR5bnIhDa+90gvzNqkglkDJ/sNAfapWr4OySW+n24hhSpSy2RF5zRwh1HfFx4EZChXKNEloPBfXDucjtjNZdj2qrhNJgAOXl/QtSI2AkQDUYVOgHyhMtEFCmXY5JMuEg1yMWgeUruJqDBrWCJQ/WOC0FQrikCC/csy4WTQo+Z5H84Fg+fd1mSqELawxddyTIwOUvg8GW3gsfhAZ3XeFwnQk8S5Z6ZIJURMlLacfgl7S+Z/HVKzgVLbspRt5TluVa3TETrDXLnUagwxrRm01W+iODGIrIBNmInzH6RJQ8hLgFJrOqQI5ZMwlKiIddgQFpDGDE5JLicIHncv7pdJNkFLaVA8+AWMtOEJ8giiyajbetbnqCVsSLlaIZMgLZuskWbb1ELAjKwGp9zplkGFrShV/MWtdw6YANS82CyG1ljk1DNajOoswr75eeJtTlt0TG3k2LoHwTDB/ZHoZ1IY3TEqyWfjqt53aO6swb2oinEO+laU6u7tJJwOnLHRn0kduGwhWmwtS8os+486B1uCUIaGbmpWYoshMgFsyOls3ZpCajOeWValaULmk3bVf9u55rfMgvtpDwjq6bglDNvrRO50GIzO/nw/l3lGIqc1LvSEAh6TGwzaBumu7eXTdupyhiXnURl+CnaoI1czFt0AixFm244lVcZCpOJVSVpcsftJJyr7i6IeJlRvC2UDujRLn3t7hBc0LbqBiSd18B34CxkmKpCV4QotGhPVdEuLRRSGkmwAbWlupwPrdcWl8YyIfydydPNNPdXbt8WQ1JdS47fxHrKpu3qeJunqI9wfWxFJqwhSpOqsa6Q88cFGjRS0pArw63S062ILZfVjip/nJq2ykFaNSo8jRFokMmGB+NiOlqYXU8TDQPJ3Cl9MxLqbmP9HL8pw4FAodwh3h9PCG64klyOO9NM0JqxrthGk1IrOq0pIdZBA4IRgF7amrANLC4tPFwP6238EdT0jg1JrhVu3yGDCTckYRJPCRwPAwQjIrTSFVcIegzzvk6NVQ6i3Z+/eHlQ11wDrlXiYU0EJV6w66GsOuBmQvTwyiZv4PY0Nw/7r7vcS/cN7H4FjUaQFtuX+yIJnoPgEmJ9cGlhDHqNQmKKYaOIJEL8CEfEekLBvGIDiPUUo1sBdxWXGiwoRYObVkzHh2TrLYfl/PoGNjyMe2fH5Aami7DMxXux1L1er9dB9l79+cefft5nwySFUf3z2cAc+rAwy5hM14cBb9ynoQv1MVR0y5Ys+LgE7iEprNNCLGPKbGMC2BSE+p0RaIIPIG+5VjJDIrdMczYUYFYpJFmKSzZDMSLig5rAetq5lH8hz56dKAvPnnUJzs4ZhjoqEtytNBNViJTkiktbThgpkYKuZpEOHm7KoMCRiG8bZidtq9ogrZ66zdojLmBv+Zm02+GSaOPkw0v6w/nR+9+O+0fXZ73B20uKqqwAtRnUjcguLCtI2oBH87oAxhAIlwEJnTFLPv396J9d8lvv3YejTzXJZ/Tk7LrXHxyfnlz3T08GRx8HtEv/9MPs5HRw/Mtxv1cdmTtPZnpcIOF/J29AGRb7BPXnzBhIm7Rc4/kCWXhOHScvMIV4IAMssze0LczJvmyIZWa4dOkY9n6hNUgrpi03RUkxJabIc6UthNXckE9IqA6yp+74NCAgsUpvZh7l7NpZU1dhZHZUqIQJT21xDrqUFMtGX8i1HkrPRlzYjdKUHhkJuOdDAWXm6koShQFDflVyrN68Jp8L0FNiptKye1R1CiN040RzC5ozJ6gniMWhKG3qXMpYI+cA5OKkmhQHVq+e7KUqMXvR8r0w+NTRyJRGLxmpWtLkC060S1PIhZoipGWVLkK0unUo2vXDtMV+DjKfmXZn9JaJAhaVs68pXS1rQ3HlJdbCNuWmRe2gLG6slCi2TcgrxrIOSpcEPhIwKxC8HQzONkOgGdOASyj2rMDy7VPlLYAMucaj21hZpWsysZC7lapfALYoi61A9l+asG2HMyYi3xtnTK6acPZVxxWcN02vthDch9HfVW6fWqyIXdZYV6T+9jnFNniNQwD4HfFyIe4qXo6TBrwWGc8WuUqUqpTpxCLof5QYeiWEbopOHwpOg9w+4IrDreYoKVJs4K5T9kB8LcCIYoxkS95xtO2+nPs/NBiTK2n8lf9if7+5ur/oCJI7ZogpkgSMGRWuiP8oDTx3gm7Txdu4ulBI/rlwRYaNG18//vTzvLXrE27TJ9x1CHcdwuiY3qRY8xUdw12HcNch3HUIdx3CXYdw1yHcdQh3HcJdh3DXIdx1CHcdwl2H8P+9Q7jr923c76O+9Hfw8eNqta8vODoeaK00WRQHSVq4k4zLWyZ4SrjMC5cYZNwYlH9Zxni0kqCxzBamr1IsPDh+aItmYAwbw2o9sDJ7fUzhemx+BUlUWqkSoSxojItKUVLF4wl0xp0WOdjfx3/P8d9L/HfwNFLOwf6+u/vSDe6LHslYMuES2hpYimddoOX4cmaZMAtjzD/D7YhnNWgyYlwUuhaTDFl6HVJmd2g72DZgYqg5jFpkUmRMLjmplgPD8eGZc0dCQOOSvmYpee+JXlL84oNkIWWG9JLG4FRnI4ulRtczmaZ8Uaa0jAtD2FAVdslWTGewrB64qnXGBN4ZkBKHrrSMS0gXJl214LI4/qrJQ849/HUP4TJ1di7HhEnCjSnwIPWx5NkxMTyF/zHXMFUggjG8Qtd4tf8C/72MFf/qP+cVKKyWTFz7Sdcesu/mH8eBPAmmc4RzvKec+7iLfJDslnGBu644TOPyb+o6PUkKCfc5JHj/e5FUkmCUkHbImQBmgFg9JWzMuCSCWdCdZU8pAztRroqgjEtIGL79RaNbbm/Z8fNKMa6qG9fpWM471eoqVuvcj4HKV8zO0V28lVdfNFvgEQrazqvc8egm0VZ4+MXFkLRL//aPgYv/0A3fL99PO1pet4/5E48tfuXy4G88vvtvX1oUAxHXHwZt/Lznnf3OPl3GG9Uwx2X7ytiMObYQpOo7iEsTqDWsFofkZu8rBjgs3Nu9XIQ8OZTDve1dRGEQQrZ8XXGCRtq9oLPZkBn4oMV8jl+7+A/fWWzRMgtxbzCWlWFnrr4R3ffstge+cxl656vnOybroXWdJJDbB+deVfzo7PR8gEYbXpnM3BlKNbvDe4Hd0S51b216o8EyFH43o4LJceEOCOr3dClO7CE1j6i2VpicVjiczfyMAVa853PaCqKECjimKv8CkStfxQ==
sidebar_class_name: "post 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={"Create a channel"}
>
</Heading>

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



Create a new notification channel.

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

<ParamsDetails
  parameters={undefined}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["nrn","type","configuration"],"properties":{"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 Slack 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":{"description":"The configuration object for the notification channel.","type":"object","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"}],"example":{"channels":["nullplatform-approvals"]}},"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":"notificationChannelCreate"},"examples":{"slack":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","source":["approval"],"description":"My Slack channel for approval notifications","type":"slack","configuration":{"channels":["my-organization-private-channel"]},"filters":{"action":"deployment:create"}}},"http":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","description":"My HTTP channel for approval notifications","source":["approval"],"type":"http","configuration":{"url":"https://yourdomain.com/url-you-configured","headers":{"Authorization":"Bearer the-token"}},"filters":{"action":"deployment:create"}}},"github":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","source":["service"],"description":"My GitHub channel","type":"github","configuration":{"installation_id":"my-installation-id","account":"my-github-org","repository":"services-opentofu","reference":"main","workflow_id":"provisioning.yml"},"filters":{"action":"deployment:create"}}},"gitlab":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","source":["service"],"description":"My GitLab channel","type":"gitlab","configuration":{"reference":"main","project_id":"1234"},"filters":{"action":"deployment:create"}}},"azure":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","source":["service"],"description":"My Azure channel","type":"azure","configuration":{"organization":"my-azure-org","project":"my-azure-project","pipeline_id":1234,"reference":"main"},"filters":{"action":"deployment:create"}}},"agent":{"value":{"nrn":"organization=1:account=2:namespace=3:application=4","source":["service"],"description":"My Agent channel","type":"agent","configuration":{"api_key":"AAAA.1234567890abcdef1234567890abcdefPTs=","command":{"data":{"cmdline":"path-to-entrypoint-file/entrypoint --service-path=\"$SERVICE_PATH\"","environment":{"NP_ACTION_CONTEXT":"${NOTIFICATION_CONTEXT}"}},"type":"exec"},"selector":{"environment":"local"}},"filters":{"service.specification.slug":"$service-spec-slug"}}}}}}}}
>
  
</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>