Pusher Docs Reference

Our Quick Start covers JavaScript. Use pusher-js with wsHost: "ws.soketify.com".

Install pusher-websocket-swift via SPM. Replace the cluster with wsHost: "ws.soketify.com" and set useTLS: true.

Add com.pusher:pusher-java-client to build.gradle. Then set setHost("ws.soketify.com"), setWsPort(443), setWssPort(443) and setUseTLS(true) on PusherOptions, and DELETE your setCluster(...) call: in this SDK setCluster overwrites the host with ws-<cluster>.pusher.com, so leaving it in place points your app at Pusher's servers instead of ours. See the Android section of our Migration guide.

Use pusher_channels_flutter. Pass host: "ws.soketify.com" and cluster: "default".

Same as the JavaScript quick start; pusher-js works in React Native. Point wsHost to ws.soketify.com.

Fully compatible: swap the Pusher app credentials for your Soketify credentials and update wsHost.

Uses presence channels, fully supported. See our Channels and Authentication docs.

Covers pusher-js API: bind, unbind, subscribe, unsubscribe. All methods work identically.

Fully covered: states, socket_id, error codes, disconnection.

Connection-level user auth (pusher.signin(), pusher.user). Always available: no app setting to turn on. Needs a /pusher/user-auth endpoint returning a signed token, and it is what enables sendToUser, #server-to-user- channels, terminate_connections and watchlist events. Turn on Authorized connections in App Settings if you want to REQUIRE it, which closes any connection that does not sign in. Not the same as channel authorization.

Notifies you when specific users go online or offline across any connection. Requires user authentication (pusher.signin). Turn on Watchlist events in App Settings and return a "watchlist" array of user ids inside user_data from your /pusher/user-auth endpoint. On signin you receive the current state of everyone you watch, then one event per transition.

Pusher Functions is a serverless compute feature specific to Pusher's cloud. Not available in Soketify. Use a regular serverless function (Cloudflare Workers, Vercel, etc.) and trigger events via the REST API instead.

Connection-level authorization that locks a connection to a specific user. Implemented alongside user authentication. Supported by Soketify.

All five channel types (public, private, encrypted, presence, cache) are documented here.

Binding, unbinding, system events, client events, naming rules: all covered.

Covers pusher-js init options: activityTimeout, pongTimeout, enabledTransports, disabledTransports, authEndpoint, auth headers, etc. All options work. Key difference: set wsHost / wsPort / wssPort instead of cluster.

pusher-js can fall back to SockJS (xhr_streaming, xhr_polling) on networks that block WebSockets. In our Quick Start we set enabledTransports: ["ws", "wss"] which disables fallbacks for simplicity. Remove that option to enable them. Required for: corporate proxies, old mobile networks, HTTP-only environments.

See the Device Compatibility section on this page.

Trigger events, batch trigger, list channels, channel info, presence users.

Server endpoint for connection-level user auth (/pusher/user-auth). Complementary to our Authentication guide which covers channel authorization.

Server-side API to push events directly to a user_id rather than a channel name. Supported by Soketify. POST to /apps/{appId}/users/{userId}/events.

Force-disconnect all connections for a given user_id. POST to /apps/{appId}/users/{userId}/terminate_connections. Supported by Soketify.

Pass socket_id to trigger/triggerBatch to exclude the sender. Covered in the Events guide.

Every official Pusher server library works with Soketify. Pass host: "api.soketify.com" instead of using the cluster option. Two libraries spell that option differently: on .NET (PusherServer) it is HostName, with no port and no scheme in the value and Encrypted = true for https, and on the Android/Java client it is setHost(), which you must not combine with setCluster() because setCluster overwrites the host. Both are shown in the Migration guide.

Deep-dive into the HMAC-SHA256 signature scheme for both channel auth and REST API auth.

The low-level WebSocket protocol Soketify implements. Only relevant if you are building a custom client library.

What a conformant Pusher server library must implement. Useful if you are building an SDK.

Enable debug logging in pusher-js with Pusher.logToConsole = true. Works identically with Soketify.