chat:ready - IBM watsonx Orchestrate ADK

Triggered when the chat is fully loaded and ready to receive user input. Use this event to perform initialization tasks such as displaying a welcome message, configuring custom header items, or setting up other UI components.

Event properties

string

required

Always 'chat:ready'.

Example

instance.on('chat:ready', (event, instance) => {
    console.log('Chat is ready for interaction');
    
    // Send a welcome message
    instance.send('Hello! How can I help you today?');
    
    // Initialize custom header items
    instance.updateCustomHeaderItems([
        {
            id: 'help',
            text: 'Help',
            type: 'menu-item',
            onClick: () => window.open('/help', '_blank')
        }
    ]);
});

Do you need practical examples?

Learn how to apply the features available for embedded chat into your implementation with guidance and examples.