Events Reference

Subscribe to lifecycle and delivery events to update your UI in real time.

const unlisten = client.onEvent((event) => {
  switch (event.type) {
    case 'CONNECTED':      showOnlineIndicator(); break;
    case 'DISCONNECTED':   showOfflineIndicator(); break;
    case 'DELIVERED':      updateReceipt(event.metadata); break;
    case 'PROCESSED':     markRead(event.metadata); break;
    case 'LIMIT_REACHED': showUpgradePrompt(); break;
    case 'ERROR':         console.error(event.reason); break;
  }
});

Event types

TypeWhen fired
CONNECTEDWebSocket handshake completed
DISCONNECTEDWebSocket closed. reason field has detail.
RECONNECTINGAuto-reconnect attempt starting
SERVER_RECEIVEDServer acknowledged receipt of your message
DELIVEREDMessage delivered to recipient's device
PROCESSEDRecipient acknowledged (read receipt)
LIMIT_REACHEDPlan message limit reached
IMPERSONATION_DETECTEDIdentity mismatch rejected by server
ERRORUnrecoverable error. Check reason.