Skip to main content
Comment events are published when comments are created, updated, or deleted on various entities throughout the platform. Comments can be attached to tickets, account tasks, account activities, and account notes. These events are delivered through the platform events system.

Developer quickstart

Minimal handler (comments only)

Checklist

  • For public email-sourced comments, expect selective content fields (privacy).
  • For large payloads, detect truncation markers and fetch full content via API.
  • Handle mentions downstream; see user:mentioned events for notifications.

Event types by entity

Comments can be associated with different entity types, and the event names reflect this:

Ticket comments

ticket:comment:created

Triggered when a comment is added to a ticket.

ticket:comment:updated

Triggered when a comment on a ticket is updated.

ticket:comment:deleted

Triggered when a comment is deleted from a ticket.

Account task comments

account-task:comment:created

Triggered when a comment is added to an account task.

account-task:comment:updated

Triggered when a comment on an account task is updated.

account-task:comment:deleted

Triggered when a comment is deleted from an account task.

Account activity comments

account-activity:comment:created

Triggered when a comment is added to an account activity.

account-activity:comment:updated

Triggered when a comment on an account activity is updated.

account-activity:comment:deleted

Triggered when a comment is deleted from an account activity.

Account note comments

account-note:comment:created

Triggered when a comment is added to an account note.

account-note:comment:updated

Triggered when a comment on an account note is updated.

account-note:comment:deleted

Triggered when a comment is deleted from an account note.

Comment event structure

Standard comment events (created/deleted)

Comment update events

For update events, the payload structure includes both previous and updated states:

Reaction events

Comments can have reactions (emoji responses) which generate their own events:

ticket:comment:reaction:added

Triggered when a reaction is added to a ticket comment.

ticket:comment:reaction:removed

Triggered when a reaction is removed from a ticket comment. Reaction event payload:

Content filtering and privacy

Email source content protection

For comments on tickets with email source and public visibility, certain content fields may be omitted from the platform payload for privacy reasons:
  • content
  • contentMarkdown
  • contentJson
Only contentHtml is included in these cases.

Large content truncation

Comments with large content (approaching the 256KB platform limit) will have their content fields truncated and replaced with “Payload too large. Use API instead”.

Event structure

All comment events follow the standard platform event structure:

Special metadata

Mention metadata

When a comment contains user mentions, the metadata may include:

Integration metadata

Comments created through integrations may include additional metadata:

Integration examples

Comment notification system

Comment synchronization

Reaction aggregation

Mention processing

Comment threading

Comments support threading through the parentCommentId field:

Attachment handling

Comments can include file attachments:

Best practices

  1. Content safety: Always sanitize comment content before displaying
  2. Mention handling: Respect user notification preferences for mentions
  3. Threading: Maintain proper parent-child relationships for threaded comments
  4. Privacy: Be aware of content filtering for email sources
  5. Performance: Consider comment volume for high-traffic tickets/entities
  6. Attachments: Implement proper security scanning for file attachments

Event frequency

Comment events can be high-frequency, especially for:
  • Active support tickets
  • Collaborative account management tasks
  • Popular discussion threads
Consider implementing:
  • Rate limiting for notification systems
  • Batching for non-critical integrations
  • Proper indexing for search systems
  • Efficient storage for comment history