API · notifications
notifications operations in the OpenAPI contract that accept an API key.
Updated:
Notificaciones por usuario (F3-88). Campana del panel, reglas del proyecto y SSE propio.
GET /notification-rules
Reglas de notificación del proyecto (F3-88)
Solo owner. Quién recibe las alertas de canal caído y de spam, y qué tipos de aviso están apagados para todo el proyecto.
- Authentication: API key or dashboard session
- Scopes: None
Responses
| Status | Description |
|---|---|
200 | OK (NotificationRules) |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
PUT /notification-rules
Guardar las reglas de notificación del proyecto
Solo owner; cookie y X-Csrf-Token. Escribe audit_log (notification_rules.updated).
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Csrf-Token | header | Yes | string |
Request body (required)
application/json: NotificationRules
Responses
| Status | Description |
|---|---|
200 | Guardadas (NotificationRules) |
403 | Error (RFC 9457) (Problem) |
422 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
GET /notifications
Mis notificaciones del proyecto (campana del panel, F3-88)
Sesión de panel de cualquier rol del equipo; las API keys reciben 403. Solo las del usuario de la sesión en el proyecto activo (RLS por proyecto y filtro por usuario), de la más nueva a la más vieja. Título y cuerpo ya vienen en el idioma de la persona (sin datos de clientes); link es la ruta del panel de la entidad. locale permite usar el idioma actual del panel; si se omite, usa el idioma de la cuenta. Retención: lo leído 14 días, todo a los 60.
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
locale | query | No | string pt, es, en | Idioma actual del panel; por defecto el de la cuenta. |
limit | query | No | integer default 30 | |
unread_only | query | No | boolean default false | |
before | query | No | string (date-time) | Cursor por fecha de creación. |
Responses
| Status | Description |
|---|---|
200 | OK (NotificationList) |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
DELETE /notifications
Borrar todas mis notificaciones del proyecto (F3-326)
Cookie y X-Csrf-Token. Vacía la campana de quien llama en el proyecto activo: usa el usuario y el proyecto de la sesión (nunca un parámetro), así que las de las demás personas y las de otros negocios quedan intactas. No toca la auditoría. Las filas de tipos apagados (in_panel = false), que solo existen para la idempotencia del aviso, se conservan. Idempotente.
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Csrf-Token | header | Yes | string |
Responses
| Status | Description |
|---|---|
204 | Campana vacía |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
POST /notifications/{id}/read
Marcar una notificación como leída
Cookie y X-Csrf-Token. Idempotente. 404 si no existe o es de otra persona (misma respuesta).
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
id | path | Yes | string (uuid) | |
X-Csrf-Token | header | Yes | string |
Responses
| Status | Description |
|---|---|
200 | OK (devuelve el contador de no leídas) (NotificationUnreadCount) |
403 | Error (RFC 9457) (Problem) |
404 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
POST /notifications/read-all
Marcar todas mis notificaciones como leídas
Cookie y X-Csrf-Token. Idempotente.
- Authentication: API key or dashboard session
- Scopes: None
Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
X-Csrf-Token | header | Yes | string |
Responses
| Status | Description |
|---|---|
200 | OK (NotificationUnreadCount) |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
GET /notifications/stream
Aviso en vivo de notificaciones nuevas (SSE)
text/event-stream, propio de la persona y del proyecto. Evento notification.created con {event, id} (sin
contenido): el cliente vuelve a pedir el contador y la lista. Un comentario : cada 15 s mantiene la conexión.
- Authentication: API key or dashboard session
- Scopes: None
Responses
| Status | Description |
|---|---|
200 | Stream abierto |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |
GET /notifications/unread-count
Cantidad de notificaciones sin leer
- Authentication: API key or dashboard session
- Scopes: None
Responses
| Status | Description |
|---|---|
200 | OK (NotificationUnreadCount) |
403 | Error (RFC 9457) (Problem) |
default | Error (RFC 9457) (Problem) |