GitScrum / Docs

Comment Created

Webhook payload reference for the comments.issues.store event, triggered when a comment is added to a task.

Triggered when a comment is added to a task.

  • Event: comments.issues.store
  • Category: Tasks
  • Triggers: Adding a comment in the task details panel

Payload

The payload contains the full comment resource via CommentResource:

{
  "id": 456,
  "resource": {
    "type": "task",
    "uuid": "abc123-def456-ghi789"
  },
  "comment": "<p>We should use OAuth 2.0 for the authentication flow.</p>",
  "keywords": ["oauth", "authentication"],
  "votes": 0,
  "is_mine": true,
  "can_delete": true,
  "replies": [],
  "user": {
    "id": 1,
    "uuid": "user-uuid-123",
    "name": "Jane Smith",
    "username": "janesmith",
    "avatar": "https://avatar.url/jane.jpg",
    "headline": "Lead Developer",
    "location": "Porto, Portugal",
    "timezone_name": "Europe/Lisbon",
    "language": "en",
    "created_at": {
      "date_for_humans": "1 year ago",
      "iso8601": "2025-01-15T10:00:00+00:00",
      "timestamp": 1736935200
    }
  },
  "users": [],
  "company": {
    "slug": "acme-corp",
    "name": "Acme Corp"
  },
  "project": {
    "slug": "web-platform",
    "name": "Web Platform"
  },
  "created_at": {
    "date_for_humans": "Just now",
    "iso8601": "2026-02-06T14:30:00+00:00",
    "timestamp": 1738852200
  },
  "updated_at": {
    "date_for_humans": "Just now",
    "iso8601": "2026-02-06T14:30:00+00:00",
    "timestamp": 1738852200
  }
}

Field Reference

FieldTypeDescription
idintegerComment ID
resource.typestringParent resource type ("task")
resource.uuidstringParent task UUID
commentstring or objectComment content (HTML string or JSON object)
keywordsarrayExtracted keyword strings
votesintegerVote count
is_minebooleanWhether the comment belongs to the authenticated user
can_deletebooleanWhether the user can delete this comment
repliesarrayNested reply comments (recursive CommentResource)
userobjectComment author
usersarrayMentioned users
companyobjectWorkspace slug and name
projectobjectProject slug and name
created_atobjectCreation timestamp
updated_atobjectLast update timestamp

Notes

  • The comment field contains HTML content.
  • The replies array can contain nested CommentResource objects for threaded comments.
  • The users array contains users mentioned in the comment (via @mentions).

Related