Skip to main content

Messenger SDK overview

OXVO Messenger SDK lets you embed support chat in web and mobile products while controlling identity, context, UI behavior, and event handling from your app code.

What it is

The Messenger SDK layer includes:

  • Runtime web client (window.oxvo) loaded from your OXVO workspace
  • React package: @oxvo/messenger
  • Vue/Nuxt package: @oxvo/messenger-vue
  • React Native package: @oxvo/messenger-reactnative

Where to find it in OXVO

  • Settings → Inboxes → [Your inbox] → Installation
  • Use this page to confirm your baseUrl and websiteToken.

When to use it

Use Messenger SDK docs when you need to:

  • Launch chat in a web or mobile app
  • Identify logged-in users
  • Pass contact or conversation attributes for routing and reporting
  • Listen to runtime events such as opened, closed, and postback
  • Tune loading behavior with lazy mode or live chat loader mode

Package map

PlatformPackageBest for
Browser (plain JS/HTML)Runtime script (/packs/js/sdk.js)Static sites or non-framework apps
React@oxvo/messengerWeb apps using React hooks/provider patterns
Vue 3 + Nuxt 3@oxvo/messenger-vueVue plugin/composable integration
React Native@oxvo/messenger-reactnativeMobile apps using an in-app modal WebView

Integration models

  1. Standard loading: Load and initialize Messenger as soon as your app shell mounts.
  2. Lazy loading: Delay SDK load until idle/interaction to reduce startup cost.
  3. Live chat loader mode: Show a lightweight launcher first, then load full Messenger only when needed.
  1. Validate baseUrl and websiteToken in a non-production environment.
  2. Install package and mount provider/plugin once at app root.
  3. Add identification flow for authenticated users.
  4. Add event listeners for analytics and workflow signals.
  5. Enable loader tuning (lazy or liveChatLoader) after baseline stability.
  6. Enforce CSP and identifier hash policy before production rollout.

📷 Image (optional): Messenger SDK package and runtime map
Why: Helps teams quickly choose the right SDK package and rollout pattern for each app stack.
File: docs/images/sdk-messenger-package-map.png
AI prompt: "Clean product documentation diagram for OXVO Messenger SDK showing four paths: Runtime Script, React SDK, Vue/Nuxt SDK, React Native SDK, with setup flow from OXVO Inbox Installation settings to app runtime; modern SaaS UI style, neutral background, sharp text, OXVO branding only, no third-party logos, 1600x1000."