Skip to content

Websocket API

ノア edited this page Apr 13, 2025 · 3 revisions

Izabela runs a local websocket server enabling you to intercept and send different events. You can use these events to interact with other applications.

Here's an example of text appearing on screen after sending messages from Izabela on Hyiro's stream:

Hyiro's stream with text appearing

API

I recommend working with socket.io to interact with these events.

Server

By default, Izabela runs a websocket server on the following address: ws://localhost:7071.

Events

Here's a list of all the events you can intercept:

Event Payload Description
message:load IzabelaMessage Triggered when a message started loading
message:response:data ResponseData Triggered when extra data for a message is available (e.g.: timestamps)
message:start IzabelaMessage Triggered when the audio for a message started playing
message:end IzabelaMessage Triggered when the audio for a message stopped playing or an error occurred
message:error IzabelaMessage Triggered when an error occurred
window:focus - Triggered when the Messenger window is focused
window:blur - Triggered when the Messenger window is blurred
input:focus - Triggered when the text input is focused
input:blur - Triggered when the text input is blurred
speech:recording:start - Triggered when speech recording started
speech:recording:end - Triggered when speech recording stopped

Here's a list of all the events you can send:

Event Payload Description
say string Send a message to Izabela

Demo

Here's a code sample using the message:start event to trigger an action on the page. Send any message from Izabela and watch the character react!

Clone this wiki locally