Documentation

Integrate real-time messaging into any platform in minutes.

Quick Start

Get ClotPulse running in your app in under 5 minutes.

1. Create an account & app

Sign up at /register, create an app, and copy your App ID, API Key, and Secret Key.

2. Install

npm install clotpulse-js      # browser client
npm install clotpulse-node    # server SDK

3. Publish your first event

import { ClotPulseClient } from 'clotpulse-js';

const client = new ClotPulseClient({
  appId:  'your_app_id',
  apiKey: 'cp_live_xxxxxxxx',
  host:   'localhost',
  port:   4000,
});

await client.connect();

const ch = client.subscribe('notifications');
ch.on('alert', (data) => console.log('Alert:', data));

4. Listen in the browser

// index.html
<script type="module">
  import { ClotPulseClient } from 'https://cdn.yourdomain.com/clotpulse.js';

  const client = new ClotPulseClient({
    appId:  'your_app_id',
    apiKey: 'cp_live_xxxxxxxx',
    host:   'localhost',
    port:   4000,
  });

  await client.connect();
  const ch = client.subscribe('notifications');
  ch.on('alert', (data) => alert(data.message));
</script>

Ready to build?

Create a free account — 300 connections, no credit card.

Start free