PieSocket Realtime SDK Configuration
Complete list of allowed configuration options supported in PieSocket Realtime SDKs: piesocket-js, piesocket-android, piesocket-swift, piesocket-flutter
Configuration options
| Option | Description | Default |
|---|---|---|
| apiKey | Required, Your PieSocket API key. | Demo key |
| clusterId | Your API key's cluster ID. | demo |
| clusterDomain | For self hosted endpoints (localhost:4001) or custom domains in managed Piesocket | null |
| ssl | Set to false to use ws:// protocol, useful for self-hosted servers | true |
| consoleLogs | Logs useful connection info if set to true. | false |
| notifySelf | Receive messages sent by self, pass 0 to disabled. | 1 |
| jwt | JWT authentication token, skips authentication endpoint call. | null |
| presence | Enable presence events on any channel, pass 1 to enabled. | 0 |
| authEndpoint | Authentication endpoint for private channels. | /broadcasting/auth |
| authHeaders | Headers to include with authEndpoint call. | {} |
| forceAuth | Force authentication on all channels. | false |
| userId | User ID, used when user does not exists in JWT payload. | anonymous |
| blockchainTestMode | Enable/disable test mode, defaults to false i.e., Ethereum main network. Set to true for Rinkeby test network. | false |
| blockchainGasFee | Gas fee to set on Ethereum contract calls | 41000 |
On this page