Skip to content

Notifications

CompozyOS Notifications HTTP endpoints.

For people running agent work32 pages in this section
GET
/api/notifications/attention

Query Parameters

receipt_profile?string

Profile owning acknowledgement receipts, including aggregate reads

workspace?string

Home workspace scope; empty selects global tasks

all_workspaces?boolean

Every project's tasks, matching an All projects Home overview

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

Response Body

Exact counts and first 100 rows; snapshot includes every occurrence

application/json
  1. response
finished*integer
items*array<>
needs_you*integer
snapshot*string
total*integer
curl -X GET "https://example.com/api/notifications/attention"
{  "finished": 0,  "items": [    {      "agent_name": "string",      "badge": "string",      "detail": "string",      "finished": true,      "generation": 0,      "id": "string",      "item_index": 0,      "kind": "string",      "loop_name": "string",      "node_id": "string",      "occurred_at": "2019-08-24T14:15:22Z",      "redacted": true,      "request_kind": "string",      "run_id": "string",      "source_id": "string",      "terminal_id": "string",      "title": "string",      "workspace_id": "string",      "workspace_label": "string"    }  ],  "needs_you": 0,  "snapshot": "string",  "total": 0}
POST
/api/notifications/attention/acknowledge

Query Parameters

receipt_profile?string

Profile owning acknowledgement receipts, including aggregate reads

workspace?string

Home workspace scope; empty selects global tasks

all_workspaces?boolean

Every project's tasks, matching an All projects Home overview

profile?string

Read one profile's rows by name

all_profiles?boolean

Read the owner-labeled all-profiles aggregate

surface?string

Snapshot owner (default bell)

Value in"bell""home"

Request Body

JSON request body

application/json
  1. body
id?string
snapshot*string

Response Body

Receipts committed atomically; source state unchanged

curl -X POST "https://example.com/api/notifications/attention/acknowledge" \  -H "Content-Type: application/json" \  -d '{    "snapshot": "string"  }'
Empty