Docs
Quick Installation
Add Heyo to your website in under a minute. Choose the method that works best for you.
Installing Heyo is easy and takes just a few seconds.
- The Script tag is the easiest way to install Heyo
- The SDK has full TypeScript support and is recommended if you know how to code.
Add this script tag before the closing </head> tag in your HTML:
<script src="https://heyo.so/embed/script" defer></script>
That's it!
The chat widget will appear on your website, and you can start chatting with your users.
Install the package with your package manager of choice:
npm install @heyo.so/js
pnpm add @heyo.so/js
yarn add @heyo.so/js
bun add @heyo.so/js
Then initialize it in your app (you can use either import style):
import HEYO from '@heyo.so/js';
HEYO.init();
And hat's it! The widget will appear on your website and you're ready to chat.
When developping locally, you need to pass a project ID to the script tag or the SDK.
Your Project ID is PROJECT_ID
<script src="https://heyo.so/embed/script" defer data-project-id="YOUR_PROJECT_ID"></script>
HEYO.init({ projectId: 'YOUR_PROJECT_ID' });
You can also find your project ID in the dashboard Project Settings