Documentation

Build with AltraNC Connect

Integration guides and API documentation for your realtime applications.

Start Here: Install and Choose Your Integration

Install PulseGrid 0.2.0 and choose the correct path for Node.js, Python, browser frameworks, or raw HTTP/WebSocket clients.

Text Authentication

Configuration, Keys and Environment Variables

Configure PulseGrid safely with environment variables, project keys and optional project ID inference.

Text Authentication

Authentication and Doctor Diagnostics

Test service health, key authentication and channel access before debugging application code.

Text Channels

Channels: List, Create and Reuse

Create channels dynamically, list existing channels and reuse a returned slug instead of hardcoding infrastructure.

Text Authentication

Client Tokens and Frontend Security

Issue short-lived channel-scoped tokens from a trusted backend and connect browser or mobile clients without exposing project secrets.

Text WebSockets

Realtime WebSockets: Connect, Send and Stay Healthy

Connect Node, browser and Python clients, send events, understand automatic heartbeat pings and handle reconnects.

Text Messages

Messages and Custom Events

Send normal text messages or structured business events over HTTP and WebSocket using the same channel model.

Text WebSockets

History and Presence

Read persisted channel history, count online identities and check whether a specific identifier is connected.

Text SDK

Framework Recipes: Express, Next.js, React, Django, FastAPI and Flask

Use the two official SDKs cleanly across common JavaScript and Python frameworks without creating a separate SDK for every framework.

HTTP Reference

Other Languages: Raw HTTP and WebSocket Protocol

Integrate Go, Java, C#, PHP, Ruby, Dart/Flutter and other environments through PulseGrid's HTTP and WebSocket protocol until dedicated SDKs exist.

Text Reference

SDK 0.2.0 Production Behaviour and Errors

Understand defaults, retries, timeouts, reconnects, heartbeat, queues and the typed errors added in PulseGrid 0.2.0.

Text Getting Started

Complete Node and Python Realtime Example

A compact end-to-end example showing two trusted backends sharing one dynamic channel through PulseGrid 0.2.0.

Text Getting Started

Push Notifications: Start Here

Understand Firebase's role, PulseGrid's role and the complete device-to-delivery flow before writing code.

Text Getting Started

Push Notifications: Connect and Verify Firebase

Connect the correct Firebase service account to a PulseGrid project and verify that Google accepts the credential.

Text SDK

Push Notifications: Register and Deactivate Devices

Text Messages

Push Notifications: Send, Target and Prevent Duplicates

Send to devices, app users, topics or roles with automatic idempotency support in PulseGrid 0.2.0.

Text Reference

Push Notifications: Status, Limits and Troubleshooting

Understand usage numbers and diagnose disabled sends, invalid tokens, pending work and successful FCM acceptance with no visible notification.

Text Getting Started

Webhooks: Start Here

Understand webhook delivery, project isolation and when to use a webhook instead of a WebSocket.

Text Getting Started

Webhooks: Endpoint URL and First Complete Test

Choose the correct receiver URL, test reachability and prove that a real channel event creates a webhook delivery.

Text Authentication

Webhooks: Verify Signatures in Node.js and Python

Verify PulseGrid webhooks with the official SDK 0.2.0 helpers using the untouched raw request body.

Text Reference

Webhooks: Payload, Projects and Event Filters

Understand the webhook envelope, project isolation, channel identity and exact event filtering.

Text Messages

Webhooks: Retries, Idempotency and HTTP Responses

Make at-least-once webhook delivery safe with delivery_id deduplication and correct receiver status codes.

Text Authentication

Webhooks: Security and Production Checklist

Protect production receivers with HTTPS, signature verification, replay checks, payload validation and safe logging.

Text Reference

Webhooks: Usage, Operations and Troubleshooting

Understand delivery counters, Celery execution and a practical diagnostic matrix for missing or failed webhooks.