Comments

Scopes: comments:read, comments:write

Posting a comment

curl -X POST https://acme.krrim.com/api/v1/comments/ \
  -H "Authorization: Bearer krm_live_..." \
  -H "Content-Type: application/json" \
  -d '{
        "task": "krrim-0042",
        "body": "Deploy 08-24 is the change. Rolling back now."
      }'

The comment is attributed to the token's service account, so it appears with that account's name rather than under a person who did not write it. Name your service accounts accordingly — "Deploy bot" reads well on a task; "API token 3" does not.

Mentions

Mentions inside a comment body notify the person mentioned, exactly as they would from the app. Resolve names to ids first:

GET /api/v1/comments/user-search/?q=dana

That endpoint requires members:read, not comments:read — it reads the roster, which is a different thing to read than a comment.

Reactions

POST   /api/v1/comments/{id}/react/
DELETE /api/v1/comments/{id}/remove-reaction/

Both require comments:write.

Notifications

A comment posted through the API notifies followers and mentioned people the same way a comment posted in the app does. An integration that writes a comment per CI run will notify everyone following that task, per run — batch into one comment, or post to a task nobody follows.

Endpoints