Set realm notification rules

Creates or changes a rule that sends matching events to a channel: for the realm (or one of its teams) with realm_id, or organization-wide with only org_id. event is an exact type (run.failed), a family (run.*) or *. recipients picks who receives it for channels that address people.

Requires a signed-in user token; with realm_id, a realm operator (or higher) with the rules.manage.realm permission on that realm; with org_id, a role with the rules.manage permission in that organization. One of realm_id or org_id is required.

POST

realms

set_notification_rules

Set realm notification rules

curl --request POST \
  --url https://{host}/v1/realms/set_notification_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
  "event": "run.failed",
  "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b"
}
'

import requests

url = "https://{host}/v1/realms/set_notification_rules"

payload = {
    "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
    "event": "run.failed",
    "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    realm_id: '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
    event: 'run.failed',
    channel_id: '9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b'
  })
};

fetch('https://{host}/v1/realms/set_notification_rules', 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://{host}/v1/realms/set_notification_rules",
  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([
    'realm_id' => '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
    'event' => 'run.failed',
    'channel_id' => '9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{host}/v1/realms/set_notification_rules"

	payload := strings.NewReader("{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{host}/v1/realms/set_notification_rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/realms/set_notification_rules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "id": "4c5d6e7f-8091-4a2b-b3c4-d5e6f7a8b9c0",
    "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
    "org_id": null,
    "team_slug": null,
    "event": "run.failed",
    "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b",
    "priority": 0,
    "created_at": 1759000000000,
    "updated_at": 1759000000000,
    "recipients": null,
    "system_key": null,
    "locked": false,
    "lock_reason": null
  }
}

Authorizations

Authorization

string

header

required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json

event

string

required

Event selector (exact type, family wildcard like run.*, or *)

Minimum string length: 1

channel_id

string

required

Target notification channel id

Minimum string length: 1

org_id

string<uuid>

Organization this call targets. Required for account-scoped channel/rule ops and inbox.

realm_id

string

When set, upsert a realm/team rule; omit for org-global

Minimum string length: 1

team_slug

string

Optional team scope under the realm

Minimum string length: 1

priority

integer

Rule priority (higher wins within a tier when supported)

recipients

string[] | null

Who receives it: invitee | org_owners | inviter | user | user ids; null = the channel destinations; omit to keep

Response

Success.

enum<boolean>

required

Always true on success.

Available options:

true

data

object

required

Show child attributes

Set realm notification rules

curl --request POST \
  --url https://{host}/v1/realms/set_notification_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
  "event": "run.failed",
  "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b"
}
'

import requests

url = "https://{host}/v1/realms/set_notification_rules"

payload = {
    "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
    "event": "run.failed",
    "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    realm_id: '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
    event: 'run.failed',
    channel_id: '9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b'
  })
};

fetch('https://{host}/v1/realms/set_notification_rules', 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://{host}/v1/realms/set_notification_rules",
  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([
    'realm_id' => '5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b',
    'event' => 'run.failed',
    'channel_id' => '9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://{host}/v1/realms/set_notification_rules"

	payload := strings.NewReader("{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://{host}/v1/realms/set_notification_rules")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{host}/v1/realms/set_notification_rules")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"realm_id\": \"5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b\",\n  \"event\": \"run.failed\",\n  \"channel_id\": \"9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b\"\n}"

response = http.request(request)
puts response.read_body

{
  "ok": true,
  "data": {
    "id": "4c5d6e7f-8091-4a2b-b3c4-d5e6f7a8b9c0",
    "realm_id": "5b0c3a7e-2f4d-4b8e-9a51-7c1d2e3f4a5b",
    "org_id": null,
    "team_slug": null,
    "event": "run.failed",
    "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b",
    "priority": 0,
    "created_at": 1759000000000,
    "updated_at": 1759000000000,
    "recipients": null,
    "system_key": null,
    "locked": false,
    "lock_reason": null
  }
}

Introduction

System

Auth

Users

Organizations

Invitations

Teams

Realms

Daemons

Workspaces

Runs

Artifacts

Events

Reviews

Notification channels

Notifications

Agents

Settings

Mesh

Jira

A2A

Set realm notification rules

Authorizations

Body

Response