Skip to content
ShipSquares

/notification-channels (POST)

POST
/notification-channels
 
curl --request POST \
  --url https://example.com/api/v1/notification-channels \
  --header 'Content-Type: application/json' \
  --data '{ "kind": "webhook", "name": "example", "url": "https://example.com", "botToken": "example", "chatId": "example", "to": "hello@example.com", "events": [ "deploy.succeeded" ] }'

Request Body required

Section titled “Request Body required ”
Media type application/json
object
kind
required
Any of:
string
Allowed values: webhook
name
required
string
>= 1 characters <= 80 characters
url
string format: uri
<= 2048 characters
botToken
string
>= 1 characters <= 256 characters
chatId
string
>= 1 characters <= 64 characters
to
string format: email
<= 254 characters
events
Array
>= 1 items

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Default Response

Media type application/json
object
id
required
string
kind
required
string
name
required
string
enabled
required
boolean
events
required
Array<string>
createdAt
required
string format: date-time
Example generated
{
  "id": "example",
  "kind": "example",
  "name": "example",
  "enabled": true,
  "events": [
    "example"
  ],
  "createdAt": "2026-04-15T12:00:00Z"
}

400

Section titled “400 ”

Default Response

Media type application/json
object
type
required
string
title
required
string
status
required
integer
code
required
string
detail
string
instance
string
errors
Array<object>
object
path
required
string
message
required
string
Example generated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "code": "example",
  "detail": "example",
  "instance": "example",
  "errors": [
    {
      "path": "example",
      "message": "example"
    }
  ]
}