Manage Documents with Tiptap

Collaboration Documents form the backbone of Tiptap Collaboration, storing everything from content and comments to versions and metadata using the Yjs format.

Typically, users manage these documents using the REST API or track changes with the Collaboration Webhook, which sends detailed updates. Tiptap converts the documents into HTML or JSON for you, so you don't have to deal directly with the Yjs format.

• Host your documents: Choose between cloud, dedicated cloud or on-premises deployment.
• Document REST API: Create, update, and delete documents programmatically.
• Webhooks: Automate responses to real-time document and comment events.
• Document versioning and comparison: Track changes in documents through automatic or manual versioning, and visually compare differences between snapshots.
• Content injection: Modify document content server-side with the REST API, even during active collaboration sessions.

Enterprise on-premises solution

Integrate Collaboration and all other Tiptap features into your infrastructure.

• On-premises:

  Deploy our docker images in your own stack

• High availability cluster:

  Scale confidently to millions of users

• Dedicated support:

  Custom development and integration support in Chat

Let's talk

Integrate documents

Integrating documents into your editor and application with Tiptap is straightforward. By adding the Tiptap Collaboration provider to your setup, documents are automatically stored and managed within the Tiptap Collaboration framework.

This integration immediately enables you to use all document features, like storing collaborative documents, managing version histories, using the REST API, and injecting content.

1. Integrate the Tiptap Editor: Follow the installation guide to setup an editor.
2. Create a Tiptap Account: Set up your Collaboration app to store you documents.
3. Integrate the Tiptap Collaboration Provider: Connect the Tiptap Editor with collaboration features to enable document management.
4. Create and Manage Documents: Start creating your first documents.

And now, you are all set to use the document features 🙌🏻

Retrieve and manage documents

Use the REST API to fetch documents in JSON or HTML format for easy integration with your system. For immediate updates on changes, configure webhooks to receive real-time notifications.

Track changes in documents: The document history extension in Tiptap Collaboration automatically captures and stores snapshots of documents at designated intervals. It also allows for manual versioning, enabling users to track detailed changes and document evolution.

Compare snapshots: The compare snapshots extension lets you visually compare two versions of a document, highlighting changes and their authors, helping you see modifications over time.

Inject content: Update the content of active documents with an Patch Document endpoint, which allows server-side modifications even during active user collaboration.