Skip to content

Customer Support Overview

The Customer Support module connects players to help, through an enterprise live-chat provider (Zendesk, Intercom), the platform's built-in REST chat, or contact details, depending on the operator's configuration. In iGaming, immediate issue resolution (especially regarding real money) is critical for player trust.

Public surface

MemberReturnsDescription
getConfig()Promise<SupportConfig>The operator's support configuration
injectWidget(config, userContext)Promise<void>Inject a provider widget (Zendesk/Intercom); see Live Chat & Widgets
initializeChat()Promise<string>Start a REST chat session (custom UI)
getSessions()Promise<ChatSession[]>The player's chat sessions; see Chat History
getHistory(sessionId?)Promise<ChatMessage[]>A session's transcript (active session when omitted)
sendMessage(body, sessionId?)Promise<ChatMessage>Send a player message
onChatMessage(listener)unsubscribe fnAgent replies in real time; see Live Chat & Widgets

Typed structures

typescript
type ChatProvider = 'ZENDESK' | 'INTERCOM' | 'CUSTOM' | 'NONE'; // closed union

interface SupportConfig {
  liveChatEnabled: boolean;
  provider: ChatProvider;
  providerKeyId?: string;   // the provider's widget key, when a provider is configured
  supportEmail?: string;
  supportPhone?: string;
}

Which provider renders what:

ProviderUI
ZENDESK / INTERCOMThe SDK injects the vendor's widget (operator choice); see Live Chat & Widgets
CUSTOMYour own chat UI on the SDK's REST chat methods
NONENo live chat; render the configured email/phone contact details

Security

Third-party widget injection is optional and operator-chosen. If configured, the vendor's script runs on the operator's origin; Content-Security-Policy is the operator's responsibility. The SDK never passes tokens or JWTs to any widget; the widget receives only the display context (name, email, tier) below.

Operator-configurable values

ValueTypeDefault / rangeEffect
Provider + widget keyper operatoroperator-definedWhich chat experience players get
Contact detailsemail/phoneoperator-definedFallback contact channels

The provider union, the session model, and the context rules are platform-fixed.