Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developer.watson-orchestrate.ibm.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
type
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.