Tasks
List activity
Read a task’s History: every edit, agent note and escalation step, newest first.
GET
Use this to see when something happened to a task. For example, the time its
status changed to completed is the occurred_at of the change event whose changes include field: "status" and new_value: "completed". The task itself only carries updated_at, which any later edit moves.
Each event has a type:
change: an edit to the task.changeslists every field it changed.agent_note: a progress note from an agent.summaryis its one-line headline.escalation: a step in an escalation raised on the task.summaryis the escalation’s title, andescalation_eventsays what happened:created,resolved,withdrawn,reassigned(it stays open with a new decider), orhost_canceled,host_archivedorhost_deleted(the task was cancelled, archived or deleted, which closed the escalation).
created_at.
actor is the person who made the change and agent_name the agent that made it. Both are set when an agent acted for a person. actor is null for an agent working on its own and for the system. It is also null when the person’s account no longer exists, so a null actor with no agent_name does not prove the system made the change.
Each change gives the value before and after twice. old_value and new_value are in the form the rest of the API uses: an enum value such as in_progress, an id without prefix, or an ISO 8601 UTC time for complete_by. old_label and new_label are the text the task History shows, such as In Progress or a person’s name. Each change’s field and the form of its values:
A label falls back to the id when the name no longer resolves, for example after a user is removed. New fields may appear as History grows, so treat a
field you do not recognise as a change to show by its labels.
Collection events carry only one side. Tag and file events (tag_added, tag_removed, file_added, file_removed) have only a label: their old_value and new_value are null. Link events (link_added, link_removed) give the linked item’s type, such as chat or review, as the value and its name as the label. Free-text fields such as title and description keep their text exactly as written.