Skip to main content

Mandatory documents

Events: checklist.mandatory_document, talk.mandatory_document, training.mandatory_document, evaluation.mandatory_document.

One notice is sent per user each time the user completes a document that is mandatory for them in a work center, according to the company's mandatory documentation configuration. Each notice includes the completed document and the status of every mandatory document of that user in that work center.

When it is sent​

A user completes a mandatory document when both of these are true:

  1. The document is mandatory for the user in the work center.
  2. The document is finished and the user took part in it within the required period:
EventFinished means
checklist.mandatory_documentThe checklist is closed and the user signed it as receiver
talk.mandatory_documentThe talk is closed and the user signed it as receiver
training.mandatory_documentThe training is closed and the user signed it as receiver
evaluation.mandatory_documentThe user finished the evaluation, whether they passed or failed
  • Closing and signing can happen in either order. The notice is sent when the second one happens.
  • A checklist that is reopened and closed again sends a new notice.
  • Editing a document that was already completed sends nothing.
  • The outcome travels in validated_document.status, not in the event name. Only evaluations can be failed.

Example​

{
"event": "talk.mandatory_document",
"user": {
"user_id": 1001,
"name": "Example Worker",
"email": "worker@example.com",
"position": "Example Position",
"branch_id": 10,
"branch": "Example Work Center"
},
"validated_document": {
"type": "talk",
"base_template": { "id": 200, "name": "Example Talk" },
"title": "Example Talk",
"status": "completed",
"frequency": "daily",
"completed_at": "2026-11-05T08:42:10-03:00"
},
"assigned_documents": [
{
"type": "talk",
"base_template": { "id": 200, "name": "Example Talk" },
"title": "Example Talk",
"status": "completed",
"frequency": "daily",
"completed_at": "2026-11-05T08:42:10-03:00"
},
{
"type": "checklist",
"base_template": { "id": 300, "name": "Example Checklist" },
"title": "Example Checklist",
"status": "pending",
"frequency": "weekly"
}
]
}

Fields​

FieldDescription
eventThe event name
user.user_idTazki user id
user.nameFull name
user.emailEmail, or null
user.positionPosition name, or null
user.branch_id, user.branchWork center where the document was completed
validated_documentThe document that was just completed (see Document)
assigned_documentsEvery mandatory document of the user in that work center only, including validated_document

Document​

FieldDescription
typechecklist, talk, training or evaluation
base_template.id, base_template.nameThe template the document is created from
titleName of the document: the latest completed one for a completed document, otherwise the latest one, or the template name if there is none
statuscompleted, pending, or failed (evaluations only, when the latest finished attempt failed)
frequencyHow often the user must complete it: none, daily, every_two_days, every_three_days, weekly, biweekly, monthly, bimonthly, quarterly, semiannual, yearly, first_day_of_month, expired, or null when the configured value is unknown
completed_atWhen the document became complete for the user: the later of the close and the user's signature (for evaluations, when it was finished). Only present when status is completed or failed

Handling duplicates​

event, user.user_id, user.branch_id, validated_document.base_template.id and validated_document.completed_at together identify a notice.