Start
Zean documentation
Everything to add the Zean chat to your website or mobile app, and connect it to your server.
Updated October 28, 2026
The Zean chat goes into your website or your app. Your Contacts write there, and your team’s members reply from your App’s inbox.
Pick your install
A website can paste the Install code, or install its framework’s SDK. Both load the same chat: its updates arrive without any change on your side.
| Your website or app | Package | Page |
|---|---|---|
| Any HTML website | Install code | Install on a website |
| Next.js, React Router, TanStack Start, React | @zean-chat/react | Install with React |
| Nuxt, Vue | @zean-chat/vue | Install with Vue |
| Expo, React Native CLI | @zean-chat/react-native | Install with React Native |
| WordPress, Shopify | Install code | Install on WordPress or Shopify |
| Any website, no framework | @zean-chat/js | Website and @zean-chat/js reference |
The same chat everywhere
Every SDK does the same things, with your framework’s names:
- Open and close the chat from your buttons: Open the chat.
- Show the number of unread replies: Unread replies.
- Pass the signed-in person’s ID, so they find their Conversation on each of their devices: Identify your Contacts.
- Send attributes, such as a city or an order count: Attributes.
- Pick the chat’s language, French or English: Language.
Your App key
Each App has a public key, for example app_your_app_key. It names your App in the code and is safe to show in your website or app. It is in App settings > Developers > Getting started, with the code ready to copy.
Opened from App settings > Developers > Getting started, the samples in this documentation show your App’s key. The webhook’s signing secret stays on your server and never shows here: see Keys and secrets.
Where the chat shows
On a website, the chat only shows on your App’s Domain, www. included, and always on localhost: you test on your computer with nothing to set. In an app, it only shows in your App’s iOS app and Android app, and always in Expo Go. Set them first, in App settings > Developers > Domain, apps and pages: without them the chat stays hidden, and your key copied elsewhere shows nothing.
How this documentation is organised
- Start: Quick start, the chat in one prompt for your AI assistant, or in three steps.
- Install: one page per kind of website or app.
- Guides: one task per page, with a tab per SDK. The tab you pick follows you from page to page.
- Your server: webhooks, their signature, testing them on your computer with the Zean CLI, and the keys, with samples in Node.js, PHP and Python.
- Reference: every option and method of every SDK.
- Help: Troubleshooting when the chat does not show.