Skip to content
Core ConceptsCLI ReferenceAPI Reference
CompozyOS RuntimeAPI Reference

Notifications

Compozy Notifications HTTP endpoints.

Audience
Operators running durable agent work
Focus
API Reference guidance shaped for scanability, day-two clarity, and operator context.

List notification presets

GET/api/notifications/presets

Query Parameters

enabled?boolean

Filter by enabled state

built_in?boolean

Filter by built-in state

name?string

Filter by exact preset name

limit?integer

Maximum number of presets to return

Formatint32

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/notifications/presets"
{  "generated_at": "2019-08-24T14:15:22Z",  "presets": [    {      "built_in": true,      "created_at": "2019-08-24T14:15:22Z",      "default_hash": "string",      "default_update_available": true,      "default_version": "string",      "enabled": true,      "events": [        "string"      ],      "filter": "string",      "name": "string",      "targets": [        {          "bridge_id": "string",          "canonical_route": "string",          "delivery_mode": "string",          "display_name": "string"        }      ],      "updated_at": "2019-08-24T14:15:22Z",      "user_modified": true    }  ],  "total": 0}

Create a notification preset

POST/api/notifications/presets

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/notifications/presets" \  -H "Content-Type: application/json" \  -d '{    "enabled": true,    "events": [      "string"    ],    "name": "string",    "targets": [      {        "bridge_id": "string"      }    ]  }'
{  "preset": {    "built_in": true,    "created_at": "2019-08-24T14:15:22Z",    "default_hash": "string",    "default_update_available": true,    "default_version": "string",    "enabled": true,    "events": [      "string"    ],    "filter": "string",    "name": "string",    "targets": [      {        "bridge_id": "string",        "canonical_route": "string",        "delivery_mode": "string",        "display_name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "user_modified": true  }}

Get one notification preset

GET/api/notifications/presets/{name}

Path Parameters

name*string

Notification preset name

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/notifications/presets/string"
{  "preset": {    "built_in": true,    "created_at": "2019-08-24T14:15:22Z",    "default_hash": "string",    "default_update_available": true,    "default_version": "string",    "enabled": true,    "events": [      "string"    ],    "filter": "string",    "name": "string",    "targets": [      {        "bridge_id": "string",        "canonical_route": "string",        "delivery_mode": "string",        "display_name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "user_modified": true  }}

Delete one custom notification preset

DELETE/api/notifications/presets/{name}

Path Parameters

name*string

Notification preset name

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/notifications/presets/string"
Empty

Update one notification preset

PUT/api/notifications/presets/{name}

Path Parameters

name*string

Notification preset name

Request Body

application/json

JSON request body

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/api/notifications/presets/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "preset": {    "built_in": true,    "created_at": "2019-08-24T14:15:22Z",    "default_hash": "string",    "default_update_available": true,    "default_version": "string",    "enabled": true,    "events": [      "string"    ],    "filter": "string",    "name": "string",    "targets": [      {        "bridge_id": "string",        "canonical_route": "string",        "delivery_mode": "string",        "display_name": "string"      }    ],    "updated_at": "2019-08-24T14:15:22Z",    "user_modified": true  }}

Bridges

Compozy Bridges HTTP endpoints.

Network

Compozy Network HTTP endpoints.