Alerts
GET /api/orgs/{org_id}/alerts
Section titled “GET /api/orgs/{org_id}/alerts”List Alerts
Page the org’s alert feed, newest occurrence first.
Private alerts (raised on a chat that is not shared) are visible only to their owner, mirroring the rule the recent-chats list already applies.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes | |
| page | query | integer | no | |
| per_page | query | integer | no | |
| status | query | "open" | "all" | no | open (default) or all |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertListResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/alerts/{alert_id}/read
Section titled “POST /api/orgs/{org_id}/alerts/{alert_id}/read”Mark Alert Read
Mark one alert read for the calling user only.
Does not resolve it: the alert stays in every member’s list, this one included, until somebody actually deals with it.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| alert_id | path | string (uuid) | yes | |
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertMutationResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/alerts/{alert_id}/resolve
Section titled “POST /api/orgs/{org_id}/alerts/{alert_id}/resolve”Resolve Alert
Close one alert for the whole org.
This is the affordance the old surface never had: an errored chat could only leave the list by being revived, so the count only ever climbed. Resolving is shared on purpose — the thing has been dealt with, so it should not still be demanding attention from four other people.
Idempotent: resolving an already-resolved alert keeps the original resolution and attribution rather than rewriting who dealt with it.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| alert_id | path | string (uuid) | yes | |
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertMutationResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/alerts/{alert_id}/unread
Section titled “POST /api/orgs/{org_id}/alerts/{alert_id}/unread”Mark Alert Unread
Undo :func:mark_alert_read for the calling user.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| alert_id | path | string (uuid) | yes | |
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertMutationResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/alerts/read-all
Section titled “POST /api/orgs/{org_id}/alerts/read-all”Mark All Alerts Read
Clear the calling user’s unread emphasis across the whole open feed.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertMutationResponse |
| 422 | Validation Error | HTTPValidationError |
POST /api/orgs/{org_id}/alerts/resolve-all
Section titled “POST /api/orgs/{org_id}/alerts/resolve-all”Resolve All Alerts
Close every open alert the caller can see, for the whole org.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
| org_id | path | string (uuid) | yes |
Responses
| Status | Description | Body |
|---|---|---|
| 200 | Successful Response | AlertMutationResponse |
| 422 | Validation Error | HTTPValidationError |