create_notification_channel

POST

/api/v1/notification-channels

curl --request POST \
  --url https://example.com/api/v1/notification-channels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "config": { "kind": "webhook", "url": "example" }, "name": "example" }'

Authorizations

• bearer

Request Body^required

Media typeapplication/json

Create-channel body: a name plus the (secret-bearing) connection config, tagged by kind.

object

config

required

One of:

object

object

kind

required

string

Allowed values: webhook

url

required

string

object

object

from

required

string

host

required

string

kind

required

string

Allowed values: email

pass

string | null

port

integer | null format: int32

to

required

string

user

string | null

object

PagerDuty Events API v2. routing_key is the integration key (a secret). api_url overrides the default US endpoint (EU: https://events.eu.pagerduty.com/v2/enqueue); allowed hosts are pinned at the API edge (validate_channel_config).

object

api_url

string | null

kind

required

string

Allowed values: pagerduty

routing_key

required

string

object

JSM Alerts / Opsgenie-compatible API. api_url is the integration base (e.g. https://api.atlassian.com/jsm/ops/integration/v2); api_key is the GenieKey (a secret).

object

api_key

required

string

api_url

required

string

kind

required

string

Allowed values: jsm

name

required

string

Responses

201

Channel created

Media typeapplication/json

The id of a freshly created resource — the whole body of a 201.

Deliberately one shape for every creator. The json!({"id": …}) literal it replaces was written out per handler, which is how {"id": …} and {"node_id": …} both ended up in this API for the same idea; a client then needs to know which creator it called to read the id back.

object

id

required

string format: uuid

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

400

Empty name, or a connection config whose URL fails the SSRF / vendor-allowlist check

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role below Admin

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

503

This core has no write side (skeleton mode)

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}