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 before the conversation restarts. Use this event for alerting the user that the chat will reset, allowing them to complete any ongoing actions or save state before the restart occurs.

​
Event properties

​
type
string
required
Always 'pre:restartConversation'.
​
interactionType
string
required
Indicates the source of the restart conversation action. Possible values:
  • 'restart_button'
    Restart triggered by clicking the Restart button in the chat header.
  • 'new_chat_button'
    Restart triggered by clicking the New Chat button in the sidebar.
  • 'instance_method'
    Restart triggered programmatically through the restartConversation() method.

​
Examples

This example shows how to handle the restart when triggered by the Restart button in the chat header: 
function preRestartConversationHandler(event, instance) {
    console.log('pre:restartConversation event', event);
    console.log('Restart source:', event.interactionType);
    
    if (event.interactionType === 'restart_button') {
        console.log('User clicked the Restart button');
    }
}

instance.on('pre:restartConversation', preRestartConversationHandler);
This example shows how to handle the restart when triggered by the New Chat button in the sidebar: 
function preRestartConversationHandler(event, instance) {
    console.log('pre:restartConversation event', event);
    console.log('Restart source:', event.interactionType);
    
    if (event.interactionType === 'new_chat_button') {
        console.log('User clicked the New Chat button');
    }
}

instance.on('pre:restartConversation', preRestartConversationHandler);
This example shows how to handle the restart when triggered programmatically through the restartConversation() method: 
function preRestartConversationHandler(event, instance) {
    console.log('pre:restartConversation event', event);
    console.log('Restart source:', event.interactionType);
    
    if (event.interactionType === 'instance_method') {
        console.log('Restart triggered programmatically');
    }
}

instance.on('pre:restartConversation', preRestartConversationHandler);

Do you need practical examples?

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