API · notifications

Operaciones de notifications del contrato OpenAPI que aceptan una clave de API.

Actualizado:

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.

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Respuestas

EstadoDescripción
200OK (NotificationRules)
403Error (RFC 9457) (Problem)
defaultError (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).

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Parámetros

NombreEnObligatorioTipoDescripción
X-Csrf-TokenheaderSístring

Cuerpo de la solicitud (obligatorio)

  • application/json: NotificationRules

Respuestas

EstadoDescripción
200Guardadas (NotificationRules)
403Error (RFC 9457) (Problem)
422Error (RFC 9457) (Problem)
defaultError (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.

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Parámetros

NombreEnObligatorioTipoDescripción
localequeryNostring pt, es, enIdioma actual del panel; por defecto el de la cuenta.
limitqueryNointeger default 30
unread_onlyqueryNoboolean default false
beforequeryNostring (date-time)Cursor por fecha de creación.

Respuestas

EstadoDescripción
200OK (NotificationList)
403Error (RFC 9457) (Problem)
defaultError (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.

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Parámetros

NombreEnObligatorioTipoDescripción
X-Csrf-TokenheaderSístring

Respuestas

EstadoDescripción
204Campana vacía
403Error (RFC 9457) (Problem)
defaultError (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).

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Parámetros

NombreEnObligatorioTipoDescripción
idpathSístring (uuid)
X-Csrf-TokenheaderSístring

Respuestas

EstadoDescripción
200OK (devuelve el contador de no leídas) (NotificationUnreadCount)
403Error (RFC 9457) (Problem)
404Error (RFC 9457) (Problem)
defaultError (RFC 9457) (Problem)

POST /notifications/read-all

Marcar todas mis notificaciones como leídas

Cookie y X-Csrf-Token. Idempotente.

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Parámetros

NombreEnObligatorioTipoDescripción
X-Csrf-TokenheaderSístring

Respuestas

EstadoDescripción
200OK (NotificationUnreadCount)
403Error (RFC 9457) (Problem)
defaultError (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.

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Respuestas

EstadoDescripción
200Stream abierto
403Error (RFC 9457) (Problem)
defaultError (RFC 9457) (Problem)

GET /notifications/unread-count

Cantidad de notificaciones sin leer

  • Autenticación: Clave de API o sesión del panel
  • Scopes: Ninguno

Respuestas

EstadoDescripción
200OK (NotificationUnreadCount)
403Error (RFC 9457) (Problem)
defaultError (RFC 9457) (Problem)