Saltar al contenido

Create a recognition

Módulo Workforce

POST/recognitionsrecognitions.create

A shout-out from one member to another, tied to a project or shift and posted to the feed. No points currency. Creates a recognition. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

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

Cuerpo de la solicitud: RecognitionCreate

recognitions.create: RecognitionCreate
CampoTipoObligatorioDescripción
to_membership_idstring (uuid)SíIdentifier of the member recognized.
project_idstring (uuid) | nullNoIdentifier of the project the recognition is for.
shift_idstring (uuid) | nullNoIdentifier of the shift the recognition is for.
messagestringSíWhat they did well.Restricciones: length 1 to 1000
{
  "to_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "Re-rigged the truss in record time."
}

Respuesta 201: Recognition

recognitions.create: Recognition
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the recognition.
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íPerson who created the row; null for seed, platform or system writes.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíPerson who last updated the row; null for seed, platform or system writes.
from_membership_idstring (uuid)SíIdentifier of the member who gave the recognition.
to_membership_idstring (uuid)SíIdentifier of the member recognized.
project_idstring (uuid) | nullSíIdentifier of the project the recognition is for.
shift_idstring (uuid) | nullSíIdentifier of the shift the recognition is for.
messagestringSíWhat they did well.Restricciones: length 1 to 1000
feed_post_idstring (uuid) | nullSíIdentifier of the recognition post in the feed.
{
  "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",
  "from_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "to_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "message": "Re-rigged the truss in record time.",
  "feed_post_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/recognitions" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"to_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shift_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"Re-rigged the truss in record time."}'
const { data } = await xos.recognitions.create({
    "to_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "message": "Re-rigged the truss in record time."
  });
response = xos.recognitions.create({"to_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "shift_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "message": "Re-rigged the truss in record time."})
xos recognitions create --data '{"to_membership_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","shift_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","message":"Re-rigged the truss in record time."}'