HIL Task Inbox

Inbox API

GET /api/hil/tasks/pending
Authorization: Bearer {userToken}

Response:
[
  {
    "taskId"         : "task-guid-001",
    "executionResId" : "corr-token-guid",
    "taskType"       : "Approval",
    "title"          : "Q3 Budget Approval",
    "instruction"    : "Please review and approve the Q3 budget.",
    "assignedTo"     : "user-abc123",
    "assignedToType" : "User",
    "processName"    : "Budget Approval Workflow",
    "createdAt"      : "2026-05-25T09:00:00Z",
    "expiresAt"      : "2026-05-26T09:00:00Z",
    "isExpired"      : false
  }
]

Task Detail

GET /api/hil/tasks/{taskId}

// Returns full task payload including:
// - payload: the context data sent from the workflow
// - formSchema: (UserForm only) the Atlas Form schema to render
// - contentToReview: (Review only) the text/HTML content to display

Respond to a Task

// Approval
POST /api/executions/{executionResId}/resume
{ "decision": "Approved", "comment": "Looks good." }

// Form Input (submit form fields)
POST /api/executions/{executionResId}/resume
{ "employeeName": "Jane Doe", "startDate": "2026-06-01", "salary": 85000 }

// Review (acknowledge)
POST /api/executions/{executionResId}/resume
{ "acknowledged": true, "comment": "Reviewed and understood." }

Inbox Location

The task inbox lives in the WorkDesk application — a separate frontend from Flow Studio's canvas. It is accessible at a URL configured by your platform administrator. The inbox is also embeddable as a widget in third-party applications using the WorkDesk widget SDK.