Skip to content

Configuration options

interface SupportDeskConfig {
// Required
appId: string; // Your App ID
apiKey: string; // Public Key (pk_live_...)
// Optional — logged-in user
customer?: {
externalId: string; // unique ID in your system
email: string;
name: string;
phone?: string;
metadata?: Record<string, unknown>;
};
// Optional — theme
theme?: {
primaryColor?: string; // accent color (hex)
position?: 'bottom-right' | 'bottom-left'; // default button position
showButton?: boolean; // show floating button (default: true)
};
}