Comments
Comments provide a threaded discussion system attached to cases, alerts, and checks. They support @mentions, emoji reactions, threading, and system-generated comments for audit compliance.Resource fields
| Field | Type | Description |
|---|---|---|
id | string | Unique comment identifier |
body | string | Comment text content |
type | string | Comment type. See comment types |
author | object | Comment author (see Author object below) |
case_token | string | Parent case token (if attached to a case) |
alert_token | string | Parent alert token (if attached to an alert) |
check_token | string | Parent check token (if attached to a check) |
parent_comment_id | string | Parent comment ID for threaded replies |
reply_count | number | Number of direct replies to this comment |
reactions | array | Emoji reactions (see Reaction object below) |
mentioned_users | array | Users @mentioned in this comment |
is_system | boolean | Whether this is a system-generated comment |
created_at | string | ISO 8601 timestamp of creation |
Nested objects
Author object
| Field | Type | Description |
|---|---|---|
id | string | User identifier |
name | string | Display name |
email | string | Email address |
photo_url | string | Profile photo URL |
initials | string | Initials derived from name |
Reaction object
| Field | Type | Description |
|---|---|---|
emoji | string | Emoji character |
count | number | Total reactions with this emoji |
user_reacted | boolean | Whether the current user reacted with this |
user_names | array | Names of users who reacted |
Comment types
| Type | Description |
|---|---|
Comment | Standard user comment |
Decision | Compliance decision recorded as a comment |
Note | Internal note (not visible to external reviewers) |
System | System-generated comment (status changes, automation) |
Example
System comment example
Threading
Comments support one level of nesting. Replies reference the parent comment viaparent_comment_id. Retrieve replies for a comment:
Notifications
The comment system sends notifications for:| Event | Notification type | Recipients |
|---|---|---|
| @mention | Push notification | Mentioned users |
| Reply to comment | Push notification | Parent comment author |
| Comment created | Platform Event | All subscribers (real-time) |
Related endpoints
| Endpoint | Method | Description |
|---|---|---|
GET /v1/cases/{token}/comments | GET | List comments for a case |
GET /v1/alerts/{token}/comments | GET | List comments for an alert |
POST /v1/cases/{token}/comments | POST | Add a comment to a case |
POST /v1/alerts/{token}/comments | POST | Add a comment to an alert |
GET /v1/comments/{id}/replies | GET | Get replies for a comment |
POST /v1/comments/{id}/reactions | POST | Add a reaction to a comment |
DELETE /v1/comments/{id}/reactions | DELETE | Remove a reaction from a comment |