Learn how to integrate Courseexe Realtime Channels into web, mobile (Flutter, iOS, Android), and backend microservices with our official libraries, direct package downloads (npm, Composer, script bundle), or raw HTTP REST APIs.
To connect your client or backend service to Courseexe Realtime Channels, use the parameters below along with your application credentials obtained from the Developer Dashboard:
| Parameter | Production Value | Description |
|---|---|---|
| host | courseexe.com | Courseexe Realtime Gateway endpoint |
| port | 443 | Encrypted TLS WebSocket & REST port |
| secure | true | Connects via wss:// and https:// |
| key | YOUR_APP_KEY | Public application identifier |
| secret | YOUR_APP_SECRET | Private server secret (never expose in client code) |
You can install our official SDKs through package managers (npm, Composer, pip) or download ready-to-use zip archives and standalone JavaScript files directly:
npm install @courseexe/realtimeComplete browser client and Node.js server trigger SDK.
composer require courseexe/realtimePHP library for HMAC-signed event publishing and channel inspects.
pip install courseexe-realtimePython package with trigger client and canonical signature helpers.
<script src="https://courseexe.com/realtime.js"></script>Zero-dependency bundle for plain HTML, WordPress, PHP, or Shopify sites.
Install from npm, yarn, or pnpm:
npm install @courseexe/realtimeor yarn / pnpmInitialize the client and bind to channel events:
For direct browser use without npm or build tooling, embed the standalone script tag directly:
Courseexe Realtime Channels is wire-compatible with Laravel Echo. Configure your `resources/js/bootstrap.js`:
Connect native mobile applications with automatic reconnection, SSL/TLS security, and full presence support:
flutter pub add courseexe_realtimehttps://github.com/projectslyai/realtime-ios.gitPodfile):pod 'CourseexeRealtime', '~> 1.0'settings.gradle.kts:app/build.gradle.kts:implementation("com.github.projectslyai:realtime-android:v1.0.1")Publish events from your backend API using `@courseexe/realtime/server`:
Trigger events from Python services using `courseexe-realtime`:
Install via Composer:
Install the official Go module:
Initialize the client and trigger events from your Go services:
Open to anyone without authentication. Useful for announcements, live scoreboards, and public data streams.
Requires server verification. When client subscribes to a channel prefixed with `private-`, the client calls your auth endpoint (`/api/realtime/auth`) with `socket_id` and `channel_name`. Your server signs the request using your `secret` with HMAC-SHA256 and returns:
{ "auth": "YOUR_APP_KEY:HMAC_SHA256_HEX_SIGNATURE" }Private channels with peer awareness. Includes member roster and automatically emits `member_added` and `member_removed` events.
If your programming language doesn't have an official SDK, you can trigger events directly via HTTP POST requests to the Courseexe Realtime Gateway:
REST requests must include query parameters signed with your application `secret` using HMAC-SHA256:
| Query Param | Type | Description |
|---|---|---|
| auth_key | string | Your public application key |
| auth_timestamp | integer | Current Unix timestamp in seconds |
| auth_version | string | Must be "1.0" |
| body_md5 | string | MD5 hex digest of the raw JSON request body |
| auth_signature | string | HMAC-SHA256 hex digest of the canonical string |
| Code | Meaning | Resolution |
|---|---|---|
| 4001 | App Key Not Found | Verify your public app key in the dashboard |
| 4004 | Over Connection Limit | Free sandbox cap is 100 concurrent sockets |
| 4009 | Auth Signature Failed | Verify private channel secret on your auth server |
| 4100 | Daily Quota Exceeded | 200k daily messages limit reached; resets 00:00 UTC |