SDK Reference

Customer Agent exposes a browser SDK for controlling the Messenger from host pages and applications: open it, close it, pass identity and context, read support and interview state, resolve sessions, and subscribe to events.

These pages are reference-first. They describe the public contract with enough detail for a developer or AI assistant to plan an integration: entrypoints, options, method signatures, event payloads, return values, and direct effects.

Start Here

• Script entry: window.CustomerAgent
• ESM entry: @customer-agent/sdk
• Options: CustomerAgentOptions
• Methods: boot, update, show, hide, toggle, shutdown, identify, setContext, on, openEntry, getState, getSession, getSupportState, getInterviewState, getInterviewSession, ensureInvitation, startInvitation, chooseInvitation, sendInterviewMessage, loadInterviewReward
• Identity and context: WidgetUser, WidgetContextJson, SetContextOptions
• Events: event names and payloads
• Support and interview sessions: support/interview state, targets, and session methods
• React: React hook exports
• AI docs: llms.txt, llms-full.txt, and markdown endpoints

SDK imports have no server-side side effects. Methods that control the Messenger are browser behavior.