What is Pulse?

Pulse adds real-time collaboration features to your website. Your users can leave comments, see each other's cursors, know who's online, and much more — without you building any of it from scratch.

What You Get

Feature	What Your Users See
Threaded Comments	Pin comments anywhere on the page. Reply, @mention, edit, delete.
Live Cursors	See other users' cursors moving in real-time with their name.
Presence	Colored avatar dots showing who's currently on the page.
Click Indicators	Brief ripple animation where someone clicked.
Reactions	Emoji reactions (thumbs up, heart, etc.) on any comment.
Typing Indicators	"Alice is typing..." shown in real-time inside threads.
Follow Mode	Click someone's avatar to auto-scroll with them.
Drawing	Freehand annotations that auto-fade after 10 seconds.
Activity Feed	Log of recent actions in the room (new threads, comments, resolves).

How It Works

You add Pulse to your website with one HTML tag. Behind the scenes, Pulse connects to our server over WebSocket and handles everything — syncing comments, broadcasting cursors, tracking presence.

<pulse-widget
  api-key="pk_your_publishable_key"
  token="USER_TOKEN"
  room="page-dashboard"
  endpoint="wss://pulse.hire.rest"
></pulse-widget>

That's the entire frontend integration. A floating toolbar appears on your page with presence avatars, comment pins, cursors, and all the features above.

Key Concepts

Before you start, here are the terms you'll see throughout:

Term	What It Means
Environment	A workspace for your app (e.g., production, staging). You get API keys per environment.
Publishable Key (pk_)	Goes in your frontend code. Identifies which environment to connect to.
Secret Key (sk_)	Goes in your backend only. Used to mint user tokens and call the REST API.
Token	A short-lived JWT that identifies a specific user. Your backend creates it using the secret key.
Room	A collaboration context — usually one per page or view. Users in the same room see each other.
Endpoint	The URL of the Pulse server (e.g., wss://pulse.hire.rest).

Next Steps

1. Quick Start — Get Pulse running on your site in 5 minutes
2. How Authentication Works — Understand the token flow
3. Admin Panel — Manage environments, keys, and team members