Saltar al contenido

Act on a notification

Módulo Platform

POST/notifications/{id}/actnotifications.act

Acts where the notification arrived, without opening its record (app.act_on_notification): approve or reject the approval an approval request asks for (app.decide_approval decides every rule; a rejection needs a comment), or mark it Done. Only the recipient acts. Push notification action buttons call this operation. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requiere la capacidad inbox.notifications.write.
  • Alcances de OAuth: inbox.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

notifications.act: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the notification.

Cuerpo de la solicitud: NotificationActRequest

notifications.act: NotificationActRequest
CampoTipoObligatorioDescripción
action"approve" | "reject" | "done"SíWhat to do.
commentstringNoReason, required when rejecting.Restricciones: length 1 to 20000
{
  "action": "approve",
  "comment": "Over the stage budget."
}

Respuesta 200: Notification

notifications.act: Notification
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the notification.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
kindstringSíNotification kind from `notification-kinds.yaml`.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
recipient_person_idstring (uuid)SíIdentifier of the person the notification is for.
read_atstring (date-time) | nullSíWhen it was read.
actor_person_idstring (uuid) | nullSíIdentifier of the person whose action caused it, when one did.
subject_tablestring | nullSíTable of the record it is about.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_idstring (uuid) | nullSíIdentifier of the record it is about.
project_idstring (uuid) | nullSíIdentifier of the project of the record, when it belongs to one.
message_argsobjectSíICU message arguments for the kind's catalog messages, such as a record title.
archived_atstring (date-time) | nullSíWhen the recipient archived it.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "kind": "timesheet.approved",
  "recipient_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "read_at": "2026-10-08T14:30:00Z",
  "actor_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "subject_table": "records",
  "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message_args": {
    "type": "doc"
  },
  "archived_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/notifications/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/act" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"action":"approve","comment":"Over the stage budget."}'
const { data } = await xos.notifications.act("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
    "action": "approve",
    "comment": "Over the stage budget."
  });
response = xos.notifications.act("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"action": "approve", "comment": "Over the stage budget."})
xos notifications act 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"action":"approve","comment":"Over the stage budget."}'