Notification Events
Our platform sends notifications for various events. This page describes the available event types.
Available Events
| Event Type | Description | Level |
|---|---|---|
upload.in_review | An upload requires manual review | Upload |
upload.processed | An upload has been completely processed | Upload |
Event Levels
Events can occur at different levels:
- Upload Level - Events related to the entire upload
- Task Level - Events related to individual tasks within an upload
Event Structure
All notification events share a common structure:
{
"id": "evt_123456789",
"event": "IN_REVIEW", // or "PROCESSED"
"event_level": "UPLOAD", // or "TASK"
"team_id": "team_123456",
"project_id": "proj_123456",
"upload": {
"id": "upl_abcdef123456",
"name": "invoice.pdf",
"status": "IN_REVIEW", // "PROCESSING", "COMPLETED", "IN_REVIEW"
"files": {},
"meta": [
{
"name": "reference",
"value": "INV-2023-001"
}
],
"folder_id": "folder_123456",
"created_at": "2023-06-15T10:30:00Z"
},
"task": null // Will contain task data if event_level is "TASK"
}
Upload In Review Event
The upload.in_review event is triggered when an upload requires manual review:
{
"id": "evt_123456789",
"event": "IN_REVIEW",
"event_level": "UPLOAD",
"team_id": "team_123456",
"project_id": "proj_123456",
"upload": {
"id": "upl_abcdef123456",
"name": "invoice.pdf",
"status": "IN_REVIEW",
"files": {},
"meta": [
{
"name": "reference",
"value": "INV-2023-001"
}
],
"folder_id": "folder_123456",
"created_at": "2023-06-15T10:30:00Z"
},
"task": null
}
Upload Processed Event
The upload.processed event is triggered when an upload is fully processed:
{
"id": "evt_123456789",
"event": "PROCESSED",
"event_level": "UPLOAD",
"team_id": "team_123456",
"project_id": "proj_123456",
"upload": {
"id": "upl_abcdef123456",
"name": "invoice.pdf",
"status": "COMPLETED",
"files": {},
"meta": [
{
"name": "reference",
"value": "INV-2023-001"
}
],
"folder_id": "folder_123456",
"created_at": "2023-06-15T10:30:00Z"
},
"task": null
}