@lukestei/embed
v0.1.11
Published
Embeddable visitor engagement widget
Readme
Embed Widget
Features
- Visitor Management: Token validation, visitor initialization, and session tracking
- Real-time Updates: Server-sent events for live status updates
- Video Calling: Daily.co integration for video calls
- Page Visibility: Automatic activity tracking based on page visibility
Development
Prerequisites
- Node.js 18+
- npm or yarn
Setup
- Install dependencies:
npm install- Start development server:
npm run dev- Build for production:
npm run buildThe built files will be in the dist/ directory.
Usage
The embed widget can be included in any website by adding a script tag:
<script src="https://cdn.jsdelivr.net/gh/lukesteinbicker/embed@main/embed.js?token=your_embed_token"></script>Or with a data attribute:
<script src="https://cdn.jsdelivr.net/gh/lukesteinbicker/embed@main/embed.js" data-token="your_embed_token"></script>API Integration
The widget integrates with the following API endpoints:
POST /api/visitors/initialize- Initialize visitor sessionGET /api/visitors/status- Get current visitor statusPOST /api/visitors/status- Update visitor statusGET /api/visitors/events?visitorId={visitorId}- Server-sent events stream
