CopilotStudioWebChatSettings interface

Package:
@microsoft/agents-copilotstudio-client

Configuration settings for the Copilot Studio WebChat connection. These settings control the behavior and appearance of the WebChat interface when connected to the Copilot Studio service.

Properties

conversationId

An existing conversation ID to resume. When provided, the connection will send subsequent messages to this conversation instead of starting a new one.

By default, providing a conversationId will skip the initial startConversationStreaming() call. Override this with the startConversation setting.

Note: The server does not validate conversation IDs. A non-existent GUID will silently create a new conversation under that ID, while a non-GUID string may cause the server to return no response. Only pass IDs that were previously captured from a real conversation.
showTyping

Whether to show typing indicators in the WebChat when the agent is processing a response. When enabled, users will see a typing indicator while waiting for the agent's reply, providing visual feedback that their message is being processed.
startConversation

Controls whether startConversationStreaming() is called when the connection is first subscribed to.

  • undefined (default): starts a new conversation only when no conversationId is provided (!conversationId).
  • true: always starts a conversation, even when resuming.
  • false: never starts a conversation, even for new connections.

Property Details

conversationId

An existing conversation ID to resume. When provided, the connection will send subsequent messages to this conversation instead of starting a new one.

By default, providing a conversationId will skip the initial startConversationStreaming() call. Override this with the startConversation setting.

Note: The server does not validate conversation IDs. A non-existent GUID will silently create a new conversation under that ID, while a non-GUID string may cause the server to return no response. Only pass IDs that were previously captured from a real conversation.

conversationId?: string

Property Value

string

showTyping

Whether to show typing indicators in the WebChat when the agent is processing a response. When enabled, users will see a typing indicator while waiting for the agent's reply, providing visual feedback that their message is being processed.

showTyping?: boolean

Property Value

boolean

startConversation

Controls whether startConversationStreaming() is called when the connection is first subscribed to.

  • undefined (default): starts a new conversation only when no conversationId is provided (!conversationId).
  • true: always starts a conversation, even when resuming.
  • false: never starts a conversation, even for new connections.
startConversation?: boolean

Property Value

boolean