undefined Logo
Docs

Introduction

Learn how to add a beautiful, customizable live-chat widget to your website with just a few lines of code.

Welcome to the Heyo documentation!

Heyo is a modern live-chat widget that helps you connect with your website visitors in real-time.

This documentation will guide you through installation, configuration, and advanced features to create the perfect support experience for your users.

Let me know if you have any questions or feedback 😃

Resources Quick Access

Quick Setup

Add Heyo to your website in under a minute with a simple script tag or npm package.

Control the Widget

Open, close, and toggle the chat on demand with simple JavaScript commands.

Identify Users

Link conversations to specific users, providing your support agents with helpful context like name and email.

Customize Dynamically

Change the widget's color, style, and position on each page to match different parts of your website.

Why use Heyo Chat Widget?

  • 🚀 Lightweight - Fast loading, minimal impact on your site's performance
  • 🎨 Beautiful Design - Modern UI that looks great out of the box
  • 📱 Responsive - Works perfectly on desktop and mobile devices
  • 🔧 Developer Friendly - Simple API with TypeScript support
  • 🌍 Multi-language - Automatic translations for global audiences

Quick Start Guide

Get Heyo running on your website in three simple steps:

Get your Project ID

Find your Project ID in the Dashboard Settings.

Add the script

Add this line before the closing </head> tag:

<script src="https://heyo.so/embed/script" defer async></script>

Start chatting

That's it! The widget will appear on your website and you're ready to chat.

Installation

Add Heyo to your website in under a minute. Choose the method that works best for you.