Skip to main content

Comment and Track Activity

Every work item has an activity stream that records comments, status changes, and other events. This guide explains how to post comments, read activities, and understand the immutability rules.

Activity types

TypeDescriptionEditable
COMMENTA user commentYes (by author)
NOTEAn internal team noteYes (by author)
STATUS_CHANGEWork item status changedNo
ASSIGNMENTAssignee added or removedNo
LABEL_CHANGELabel added or removedNo
LINK_CHANGELink added or removedNo
SYSTEMSystem-generated eventNo

Post a comment

POST /rest/v1/t_ppm_activities
{
"work_item_id": "e5f6a7b8-...",
"activity_type": "COMMENT",
"activity_body": "The mockups have been reviewed. Moving to implementation."
}
Response (201 Created)
{
"id": "act-0001-...",
"work_item_id": "e5f6a7b8-...",
"activity_type": "COMMENT",
"activity_body": "The mockups have been reviewed. Moving to implementation.",
"created_by": "u1v2w3x4-...",
"created_date": "2026-05-05T14:30:00+00:00"
}

Post an internal note

Internal notes work the same as comments but are used for team-internal communication:

POST /rest/v1/t_ppm_activities
{
"work_item_id": "e5f6a7b8-...",
"activity_type": "NOTE",
"activity_body": "Checked with the backend team — the endpoint is ready."
}

Edit a comment or note

Only the author can edit their own comments and notes:

PATCH /rest/v1/t_ppm_activities?id=eq.act-0001-...
{
"activity_body": "The mockups have been reviewed and approved. Moving to implementation."
}
warning

Only COMMENT and NOTE activities can be edited, and only by the user who created them. All other activity types are immutable — the system rejects any update attempt.

Read the activity stream

Retrieve all activities for a work item, ordered by most recent first:

GET /rest/v1/t_ppm_activities?work_item_id=eq.e5f6a7b8-...&order=created_date.desc

Automatic status-change entries

When you update a work item's work_item_status, the system automatically creates a STATUS_CHANGE activity. The activity_data field records the old and new values:

Auto-generated STATUS_CHANGE activity
{
"id": "act-0002-...",
"work_item_id": "e5f6a7b8-...",
"activity_type": "STATUS_CHANGE",
"activity_body": null,
"activity_data": {
"old_status": "BACKLOG",
"new_status": "IN_PROGRESS"
},
"created_date": "2026-05-03T09:00:00+00:00"
}

Immutability rules

  • COMMENT and NOTE — editable by the original author only.
  • STATUS_CHANGE, ASSIGNMENT, LABEL_CHANGE, LINK_CHANGE, SYSTEM — these are system-generated records and cannot be modified or deleted. Any attempt to update them is rejected.

This ensures the activity stream provides a reliable audit trail of everything that has happened on a work item.