Notifications
2 methods on the Notifications resource.
2 methods · 2 available to app tokens36 pages in SDK Reference
import { Compozy } from "@compozy/client";2 of 2
acknowledgeAttentionNotifications
Acknowledge an exact notification snapshot
compozy.notifications.acknowledgeAttentionNotifications({ query, body }) → Promise<void>
Options
- receipt_profilestringquery
- Profile owning acknowledgement receipts, including aggregate reads
- workspacestringquery
- Home workspace scope; empty selects global tasks
- all_workspacesbooleanquery
- Every project's tasks, matching an All projects Home overview
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
- surface"bell" | "home"query
- Snapshot owner (default bell)
Request bodyAcknowledgeAttentionRequest
POST /api/notifications/attention/acknowledgeapp tokens allowed
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.notifications.acknowledgeAttentionNotifications({ body: { /* request fields */ } });listAttentionNotifications
List unread operator notifications across all workspaces and source profiles
compozy.notifications.listAttentionNotifications({ query }) → Promise<AttentionNotificationsResponse>
Options
- receipt_profilestringquery
- Profile owning acknowledgement receipts, including aggregate reads
- workspacestringquery
- Home workspace scope; empty selects global tasks
- all_workspacesbooleanquery
- Every project's tasks, matching an All projects Home overview
- profilestringquery
- Read one profile's rows by name
- all_profilesbooleanquery
- Read the owner-labeled all-profiles aggregate
GET /api/notifications/attentionapp tokens allowed
example.ts
import { Compozy } from "@compozy/client"; const compozy = await Compozy.connect();const result = await compozy.notifications.listAttentionNotifications();