Events

Events allow your application to dynamically respond to changes in user context instantly. These events are automatically captured when relevant changes occur. You can subscribe to them by registering event listeners.

Key Considerations

Please note the following:

Events will only trigger for active connections.
Events are not captured unless explicitly listened for.
A single instance of the eventQueue is shared across all connections.

Quick Start Guide

Start listening in the loop with `listenForEvents`. \

The function EventQueue.waitEvent returns a event when one is captured.

JavaScript

const eventQueue = await Endpoint.getEventQueue();
function listenForEvents(eventsQueue) { 
eventsQueue.waitEvent().then(event => {
    console.log("onEvent", event);
    listenForEvents(eventsQueue);
});
}
listenForEvents(eventQueue);

JavaScript

const subscriptions = await threadApi.subscribeFor([
    // subscribe to `threadNewMessage` events in the given Thread
    await threadApi.buildSubscriptionQuery(
        ThreadEventType.MESSAGE_CREATE, 
        ThreadEventSelectorType.THREAD_ID, 
        threadId
    )
]);

Unsubscribe, if events no longer needed:

JavaScript

await threadApi.unsubscribeFrom(subscriptions);

Key Considerations

Quick Start Guide

Start listening in the loop with listenForEvents. \

Subscribe to Tool (e.g. Thread) events:

Unsubscribe, if events no longer needed:

On this page

Start listening in the loop with `listenForEvents`. \