Integrate Comments into your app

The comments extension allows users to create threads and comments in your editor. Threads can be used to discuss specific parts of the document, or to add comments to specific parts of the document.

Comments can be accessed and manipulated through the Comments REST API or received via Webhooks, enabling the creation of notification systems and the addition of comments from outside the Editor.

Subscription required

This extension requires a valid Entry, Business or Enterprise subscription and a running Tiptap Cloud instance. To install the extension you need access to our private registry, set this up first.

For simpler examples, begin with the Install section.

Comments features

  • Inline, Documents and Sidebar comments
  • Commenting on text, nodes, custom nodes and across a selection of nodes
  • Rich text support within comments (bold, emojis, etc.)
  • Resolving, editing and deletion of comments
  • Offline commenting support
  • Overlapping comments
  • Mentioning of users within comments
  • A webhook that allows you to integrate your own notification service in case someone is mentioned
  • A comments API that allows to programmatically interact with the comments