Skip to main content
POST
/
v5
/
notifications
/
settings
Create a new notification settings
curl --request POST \
  --url https://api.kadoa.com/v5/notifications/settings \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "eventConfiguration": {},
  "workflowId": "<string>",
  "enabled": true,
  "channelIds": [
    "<string>"
  ]
}
'
import requests

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

payload = {
"eventConfiguration": {},
"workflowId": "<string>",
"enabled": True,
"channelIds": ["<string>"]
}
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({
eventConfiguration: {},
workflowId: '<string>',
enabled: true,
channelIds: ['<string>']
})
};

fetch('https://api.kadoa.com/v5/notifications/settings', 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/settings",
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([
'eventConfiguration' => [

],
'workflowId' => '<string>',
'enabled' => true,
'channelIds' => [
'<string>'
]
]),
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/settings"

payload := strings.NewReader("{\n \"eventConfiguration\": {},\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"channelIds\": [\n \"<string>\"\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/settings")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"eventConfiguration\": {},\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"channelIds\": [\n \"<string>\"\n ]\n}")
.asString();
require 'uri'
require 'net/http'

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

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 \"eventConfiguration\": {},\n \"workflowId\": \"<string>\",\n \"enabled\": true,\n \"channelIds\": [\n \"<string>\"\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "settings": {
      "id": "<string>",
      "workflowId": "<string>",
      "eventType": "<string>",
      "eventConfiguration": {},
      "enabled": true,
      "channels": [
        {
          "id": "<string>",
          "name": "<string>",
          "channelType": "<string>"
        }
      ],
      "createdAt": "<string>",
      "updatedAt": "<string>"
    }
  },
  "status": "<string>",
  "message": "<string>"
}

Authorizations

x-api-key
string
header
required

API key for authentication

Body

application/json
eventType
enum<string>
required
Available options:
workflow_started,
workflow_finished,
workflow_failed,
workflow_sample_finished,
workflow_data_change,
system_maintenance,
service_degradation,
credits_low,
free_trial_ending
eventConfiguration
object
required

Settings specific to the event type. Currently accepts an empty object {}. This object will be extended in future releases to support event-specific configuration options.

workflowId
string

Workflow ID (optional, if not provided creates workspace-level settings)

enabled
boolean
default:true
channelIds
string[]

Array of channel IDs to link to this Settings

Response

Settings created successfully

data
object
status
string
message
string