Skip to main content
POST
/
v5
/
notifications
/
channels
Create a new notification channel
curl --request POST \
  --url https://api.kadoa.com/v5/notifications/channels \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "config": {
    "recipients": [
      "user@example.com",
      "admin@company.com"
    ],
    "from": "notifications@kadoa.com"
  }
}
'
import requests

url = "https://api.kadoa.com/v5/notifications/channels"

payload = {
"name": "<string>",
"config": {
"recipients": ["user@example.com", "admin@company.com"],
"from": "notifications@kadoa.com"
}
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
config: {
recipients: ['user@example.com', 'admin@company.com'],
from: 'notifications@kadoa.com'
}
})
};

fetch('https://api.kadoa.com/v5/notifications/channels', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.kadoa.com/v5/notifications/channels",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'config' => [
'recipients' => [
'user@example.com',
'admin@company.com'
],
'from' => 'notifications@kadoa.com'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.kadoa.com/v5/notifications/channels"

payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"config\": {\n \"recipients\": [\n \"user@example.com\",\n \"admin@company.com\"\n ],\n \"from\": \"notifications@kadoa.com\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.kadoa.com/v5/notifications/channels")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"config\": {\n \"recipients\": [\n \"user@example.com\",\n \"admin@company.com\"\n ],\n \"from\": \"notifications@kadoa.com\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.kadoa.com/v5/notifications/channels")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"config\": {\n \"recipients\": [\n \"user@example.com\",\n \"admin@company.com\"\n ],\n \"from\": \"notifications@kadoa.com\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "channel": {}
  },
  "status": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
name
string
required
channelType
enum<string>
required
Available options:
EMAIL,
SLACK,
WEBHOOK,
WEBSOCKET
config
object
required

Configuration object specific to the channel type

Response

Channel created successfully

data
object
status
string
message
string