SDK & Widget · Get started

SDK & Widget overview

Put Inboxi live chat inside your website or mobile app. Your visitors chat in your product; your team and your AI agent answer from the same Inboxi inbox.

The Inboxi SDK is the set of tools that brings the conversation surface into products you own. Every message a visitor sends from your site or app lands in your shared inbox as a widget conversation, your AI agent answers it according to the widget's settings, and replies from your team are delivered back in real time. When the visitor has closed the app, Inboxi can wake them with a push notification.

What is included

Website widget
One script tag adds a floating chat launcher to any website. Identify signed-in users and control it from JavaScript.
React Native SDK
Drop-in ChatScreen component plus an InboxiChat client for session, identity, history and push.
SDK REST API
The HTTP endpoints behind the SDK. Use them directly from Flutter, Swift, Kotlin or any other stack.
Real-time (Socket.IO)
Live delivery of replies, typing and system events over a WebSocket connection.
Push notifications
Inboxi sends FCM / APNs pushes with your credentials, or notifies your server through webhooks.
Authentication
App ID + API key in, short-lived session token out. Where to find your credentials.

How it works

Every integration, whether it is the web widget, the React Native SDK or your own native client, follows the same four steps. The web widget performs them for you; on mobile you call them yourself (or let the React Native SDK do it).

Init
POST /sdk/init with your API key. Returns a session token and the widget look.
session token
Identify
Attach the signed-in user (name, email, phone, custom data) to the session.
chatId
Chat
Send over Socket.IO or REST. Replies arrive live on the socket.
agent replies
Push
Visitor offline? Inboxi pushes the reply to the registered device.
  1. Your site or app connects to Inboxi through the widget script or the SDK API.
  2. The visitor sends a message, and it appears in your Inboxi inbox.
  3. Your AI agent or your team replies from the dashboard; the reply is delivered in real time.
  4. If the visitor is offline, Inboxi sends a push notification (when configured).

Choose your integration

You are buildingUseWhat you write
A website, landing page or web appWebsite widgetOne script tag, optionally window.InboxiSettings for signed-in users.
A dedicated support pageFull-page embedAn iframe that shows the chat without the floating launcher.
A React Native appReact Native SDKinit() at startup, identify() after login, render <ChatScreen />.
A Flutter, iOS (Swift) or Android (Kotlin) appSDK REST API + Socket.IOYour own chat UI on top of the same endpoints and events the React Native SDK uses.

Where the conversations go

SDK and widget conversations are ordinary Inboxi conversations. They appear in the inbox next to WhatsApp, Instagram and email, with the visitor's name and any custom data you passed shown on the contact. The AI agent selected in the widget settings answers them, and anyone on your team can take over. Read more in Conversations and Website chat widget.

Same identity everywhere
When you pass the same email or phone from the web widget and from your app, Inboxi files both on the same contact. See Widget identity & merge for the rules.

Plans and limits

  • The /api/widget/sdk/* endpoints are gated by the widget plan feature and need an API key that carries the widget permission.
  • Push notifications and the wider REST API are gated by their own plan features. The live mapping is on Plans & features map, prices on inboxi.app/pricing.
  • Base URL for every call: https://inboxi.app.