Notifications¶
Notifications inform you about activity in your projects — agent questions awaiting your response, completed background tasks, errors, and other system events.
Notification fields¶
| Field | Description |
|---|---|
title |
Short heading |
message |
Full notification body |
severity |
info · warning · error · success |
importance |
important · other |
category |
Optional grouping label |
relatedResourceType |
The type of resource this notification relates to |
relatedResourceId |
UUID of the related resource |
actionUrl |
Optional deep link to the relevant UI page |
actionLabel |
Button label for the action link |
read |
Whether you have read the notification |
dismissed |
Whether you have dismissed it |
expiresAt |
Optional auto-expiry timestamp |
Listing Notifications¶
Filter by tab¶
| Tab | What it shows |
|---|---|
all |
Every non-dismissed notification |
important |
High-importance notifications only |
other |
Normal-importance notifications |
snoozed |
Notifications snoozed until a future time |
cleared |
Previously dismissed notifications |
Notification Counts¶
Get the unread badge counts for the UI:
Response:
Marking as Read¶
Mark a single notification as read:
Mark all as read:
Dismissing a Notification¶
Dismissed notifications move to the cleared tab and are hidden from the default view.
Real-Time Updates (SSE)¶
Subscribe to a server-sent event stream to receive notifications in real time without polling:
Events are emitted for:
- New notifications
- Agent run status changes
- Agent questions (pause/resume)
- Background task completions
- Document conversion completions
The stream stays open; reconnect automatically if it drops.