API Reference
Events, methods, and programmatic control for the hooman.live widget.
Widget States
The hooman.live widget transitions through several states during its lifecycle.
| State | Description |
|---|---|
COLLAPSED | Small floating button - the default idle state |
EXPANDED | Panel with action buttons visible |
WAITING | Connecting to a rep with countdown timer |
INCOMING_PING | Rep is reaching out - shows Accept/Decline popup |
IN_CALL | Active video call with controls |
POPPED_OUT | Call has been moved to a separate browser window |
WebSocket Events
The widget uses WebSocket for real-time communication with the server.
| Event | Direction | Description |
|---|---|---|
presence | Server → Client | Notifies about rep availability status |
call_starting | Server → Client | A call is being initiated with connection details |
ping | Server → Client | A rep is reaching out to the visitor |
call_ended | Server → Client | The call has been terminated |
JavaScript API
🚧
Coming Soon
Programmatic JavaScript API for controlling the widget, listening to events, and customizing behavior is coming soon.
REST API
🚧
Coming Soon
REST API documentation for server-side integration is coming soon.