Documentation

Build with AltraNC Connect

Integration guides and API documentation for your realtime applications.

JavaScript Getting Started

Install PulseGrid JavaScript Package

Install the official PulseGrid JavaScript SDK from npm.
JavaScript Getting Started

PulseGrid JavaScript Quick Start

Set up PulseGrid quickly in JavaScript with a simple SDK-style flow.
JavaScript SDK

createPulseGrid Function

Create the main PulseGrid JavaScript client.
JavaScript Authentication

testAuth Function in JavaScript

Verify that your PulseGrid JavaScript keys are valid.
JavaScript Reference

projects.list Function in JavaScript

Fetch the project linked to the configured PulseGrid keys.
JavaScript Authentication

tokens.create Function in JavaScript

Create a short-lived client token for frontend or mobile realtime access.
JavaScript Channels

channel().list Function in JavaScript

List channels in the configured project.
JavaScript Channels

channel().create Function in JavaScript

Create a realtime channel from JavaScript backend code.
JavaScript WebSockets

channel().connect Function in JavaScript

Open a realtime websocket connection in JavaScript.
JavaScript Messages

chat.send Function in JavaScript

Send a realtime websocket message in JavaScript.
JavaScript Messages

channel().publish Function in JavaScript

Publish a server-side event into a channel over HTTP.
JavaScript WebSockets

Presence in JavaScript

Check live online count, full presence snapshot, and whether a specific identifier is online.
JavaScript WebSockets

Presence Event Types

Understand the websocket presence event types returned by PulseGrid.
JavaScript Getting Started

Full JavaScript SDK Example

A full PulseGrid JavaScript example showing setup, token creation, connection, presence, send, and publish.
Python Getting Started

Install PulseGrid Python Package

Install the official PulseGrid Python SDK from PyPI.
Python Getting Started

PulseGrid Python Quick Start

Set up PulseGrid quickly in Python with a simple SDK-style flow.
Python SDK

create_pulsegrid Function

Create the main PulseGrid Python client.
Python Authentication

test_auth Function in Python

Verify that your PulseGrid Python keys are valid.
Python Reference

projects.list Function in Python

Fetch project information linked to the configured Python keys.
Python Authentication

tokens.create Function in Python

Create a short-lived PulseGrid client token in Python.
Python Channels

channel().create Function in Python

Create a realtime channel in Python.
Python WebSockets

channel().connect Function in Python

Connect to a realtime PulseGrid channel over WebSocket in Python.
Python Messages

connection.send Function in Python

Send a websocket message in Python.
Python Messages

channel().publish Function in Python

Publish a server-side event into a PulseGrid channel over HTTP in Python.
Python WebSockets

Presence in Python

Check live online count, full presence snapshot, and whether a specific identifier is online in Python.
Python Getting Started

Full Python SDK Example

A full PulseGrid Python example showing setup, token creation, connection, presence, send, and publish.
Python Reference

Python Install Verification Example

A simple Python package verification doc showing how to test install, import, and expected results.
JavaScript Reference

JavaScript Install Verification Example

A simple JavaScript package verification doc showing how to test install, import, and expected results.
Text Reference

Sender Identity in PulseGrid

Understand identifier_id and identifier_label and how PulseGrid uses them to identify who sent a message.
JavaScript Getting Started

Browser and React Client Snippet

A simple browser or React-style snippet showing how a frontend client would connect using a short-lived token.
JavaScript Getting Started

Expo and React Native Snippet

A simple Expo / React Native-style snippet showing how a mobile app would connect using a short-lived token.
Text Getting Started

Flutter Snippet

A simple Flutter websocket snippet using a short-lived PulseGrid client token.
Python Getting Started

Django Backend Snippet

A Django backend example showing how to call PulseGrid securely using project keys.
HTTP Reference

Raw HTTP API Snippet

A raw HTTP example for teams that want to call PulseGrid without using a local SDK wrapper.
Text Getting Started

Webhooks: Start Here

Understand what a webhook is, when to use one, and how PulseGrid delivers live project events to your backend.
HTTP Getting Started

Webhooks: What Endpoint URL Means

Learn exactly which URL to paste when creating a webhook endpoint and what must exist at that address.
Text Getting Started

Webhooks: First Complete Test

Test a manual delivery and then prove that a real channel event reaches the receiver automatically.
JavaScript Reference

Webhooks: Payload Reference

Understand every field in the JSON webhook envelope, including event IDs, delivery IDs, sender and source.
Text Reference

Webhooks: Projects, Channels and Event Filters

Control exactly which project events reach each destination and understand why cross-project delivery is blocked.
Python Authentication

Webhooks: Verify Signatures in Python and Django

Secure a Python or Django receiver by verifying PulseGrid's timestamped HMAC-SHA256 signature.
JavaScript Authentication

Webhooks: Verify Signatures in Node.js

Verify PulseGrid webhook signatures in an Express backend without changing the raw request bytes.
Python Messages

Webhooks: Duplicate Protection and Idempotency

Make retries safe by ensuring each webhook delivery performs business work only once.
HTTP Reference

Webhooks: Delivery Statuses, Retries and HTTP Responses

Understand Pending, Retrying, Succeeded and Failed deliveries and choose the correct receiver response.
HTTP Authentication

Webhooks: Headers and Security Checklist

Use PulseGrid's delivery headers safely and protect production receivers from forged requests and data leakage.
Text Getting Started

Push Notifications: How the Pieces Fit Together

Understand exactly what Firebase, the client app and PulseGrid each do before configuring Push.
Text Reference

Webhooks: Usage, Limits and Platform Controls

Understand endpoint allowances, delivery metering, retry costs and the admin tables controlling webhook profitability.
Text Getting Started

Push Notifications: Connect and Verify Firebase

Connect the correct Firebase application, understand legacy imported connections and verify the credential.
Bash Getting Started

Webhooks: Local and Production Operations

Run webhook delivery locally without extra services, then switch safely to Redis and Celery in production.
HTTP SDK

Push Notifications: Register and Remove Devices

Register web, Android and iOS FCM tokens without exposing PulseGrid secret keys.
Text Reference

Webhooks: Troubleshooting

Diagnose missing deliveries, invalid signatures, repeated retries, wrong project selection and receiver failures.
HTTP Messages

Push Notifications: Send Safely and Prevent Duplicates

Queue targeted notifications and use idempotency keys so retries cannot create duplicate campaigns.
Text Reference

Push Notifications: Metering, Limits and Troubleshooting

Understand every Push usage number and diagnose why a notification did not appear.