Pingerchips LogoPingerchips

App Settings

Every Pingerchips app has a set of configuration options you can manage from the dashboard at Dashboard → Apps → [Your App].

Credentials

FieldDescription
App KeyPublic identifier. Clients connect with it; it appears in channel topics. Safe to ship in frontend code.
App SecretPrivate. Authenticates server calls and mints capability tokens. Never expose in client code.
App IDInternal identifier. Interchangeable with the App Key on most APIs.

Keep the App Secret in environment variables:

PINGERCHIPS_APP_KEY=your-app-key
PINGERCHIPS_APP_SECRET=your-app-secret

Which credential goes where

CallAuth
Browser client connect (Pingerchips, PingerchipsChat, PingerchipsSpaces)App Key only
A browser joining a private / presence channel, a Durable Object, or a chat threada capability token your backend minted
Every server-to-server HTTP call — trigger, push, history, Durable Objects, chat REST, POST /api/authX-App-Key + X-App-Secret headers

See Authentication for the full model.


Toggles

Active

Enables or disables the entire app.

  • On — clients can connect and events flow normally.
  • Off — all new connection attempts are rejected. Existing connections are dropped.

Use this to take an app offline for maintenance without deleting it.


Enable Client Messages

Controls whether clients can send events to other clients through Pingerchips (client-triggered events).

  • On — a client can call channel.trigger('event', data) and the event is processed by the flow and broadcast to other subscribers.
  • Offchannel.trigger(...) calls are rejected with {reason: "Client messages are disabled for this app"}.

Disable client messages if your app only needs server → client broadcasts and you don't want clients sending arbitrary events.


Enable User Authentication

Controls whether private and presence channels require authentication.

  • Off (default) — any client can join any channel, including private- and presence- prefixed ones, without an auth signature. Also lets chat clients join a thread without a JWT.
  • On — clients joining private-* or presence-* channels must provide a valid HMAC auth signature; chat clients must present a JWT capability token. Public channels are unaffected.

When enabled, configure an auth endpoint in your client SDK:

const client = new Pingerchips('YOUR_APP_KEY', {
  authEndpoint: '/pingerchips/auth',
  authInfo: { token: userSessionToken },
});

See Channel Types for how to implement the auth endpoint.


Rate Limits

Rate limits are configured per-app and enforced server-side. They protect your app and other tenants from traffic spikes.

SettingDefaultDescription
Max ConnectionsUnlimited (-1)Maximum simultaneous WebSocket connections
Max Backend Events/sec1000Events per second via the HTTP trigger API
Max Client Events/sec1000Events per second from WebSocket clients
Max Read Requests/secUnlimited (-1)HTTP read requests per second

When a limit is exceeded the server returns HTTP 429 Too Many Requests or a WebSocket error {reason: "Rate limit exceeded"}.

-1 means unlimited. Contact support to raise limits on paid plans.


Message Constraints

Enforce size and naming constraints on events flowing through your app.

SettingDefaultDescription
Max Event PayloadUnlimitedMaximum JSON payload size in KB
Max Event Name LengthUnlimitedMaximum character length of event names
Max Channel Name LengthUnlimitedMaximum character length of channel names
Max Event Batch SizeUnlimitedMaximum events per batch trigger request
Max Event Channels at OnceUnlimitedMax channels a single event can target

When a constraint is violated the request is rejected with HTTP 422 Unprocessable Entity and an error message describing which limit was exceeded.


Presence Settings

SettingDescription
Max Presence Members/ChannelMaximum subscribers tracked in a presence channel
Max Presence Member SizeMaximum size of a presence member's data (in KB)

Webhooks

Configure HTTP endpoints to receive notifications when events occur on your app. Each webhook entry specifies:

  • URL — your server endpoint
  • Events — which event types trigger the webhook

Webhook payloads are delivered as POST requests with a JSON body.


Next Steps

On this page