Set organization notification rules

Creates or changes an organization-wide rule that sends matching events to a channel of the organization. event is an exact type (run.failed), a family (run.*) or *. Built-in rules cannot be changed.

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 /v1/orgs/set_notification_rules

Set organization notification rules

cURL

curl --request POST \
  --url https://{host}/v1/orgs/set_notification_rules \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f",
  "event": "run.*",
  "channel_id": "9a8b7c6d-5e4f-4321-8a0b-1c2d3e4f5a6b"
}
'

200

Example

{ "ok": true, "data": { "id": "4c5d6e7f-8091-4a2b-b3c4-d5e6f7a8b9c0", "realm_id": null, "org_id": "2c3d4e5f-6a7b-4c8d-9e0f-1a2b3c4d5e6f", "team_slug": null, "event": "run.*", "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

200

application/json

Success.

ok · enum<boolean> · required

Always true on success.

Available options: true

data · object · required

Show child attributes