API Docs / Schemas / TaskItemHistoryEventDto

TaskItemHistoryEventDto

A single event in a task's history timeline — a status or assignee change
on the task itself or one of its workflow steps.

Properties

Name Type Description
timestampstring

When the change happened (UTC)

When the change happened (UTC)

eventTypeenum

TaskCreated TaskStatusChanged TaskAssigneeChanged StepStatusChanged StepAssigneeChanged

TaskCreated TaskStatusChanged TaskAssigneeChanged StepStatusChanged StepAssigneeChanged

stepNamestring

The name of the workflow step the event relates to. Null for task-level events.

The name of the workflow step the event relates to. Null for task-level events.

fromStatusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

toStatusenum

NotStarted InProgress Blocked Completed Skipped

NotStarted InProgress Blocked Completed Skipped

fromAssigneeUserCodeAndNameDto
fromAssigneeTeamCodeAndNameDto
toAssigneeUserCodeAndNameDto
toAssigneeTeamCodeAndNameDto
stageClientBillableServiceStageDto
changedByUserCodeAndNameDto
changedByClientNamestring

Display name of the external (client) actor that made the change — the contact
name resolved at write time, falling back to their email. Null for staff/system changes.

Display name of the external (client) actor that made the change — the contact
name resolved at write time, falling back to their email. Null for staff/system changes.

changedByTypeenum

System User Portal MagicLink

System User Portal MagicLink

JSON Example

{
  "timestamp": "2024-01-01T00:00:00Z",
  "eventType": "TaskCreated",
  "stepName": "string",
  "fromStatus": "NotStarted",
  "toStatus": "NotStarted"
}