webchat-setup

Webchat v3 Setup Guide

What is Webchat v3?

Webchat v3 is Cognigy's embeddable chat widget for websites. It connects to a Webchat v3 Endpoint, which links a Flow to the widget and holds all appearance/behavior configuration.

Quick Start — Minimal Webchat

1. Ensure an agent + flow exist: create_ai_agent { name: "My Agent" }
2. Create a webchat endpoint: manage_webchat { projectId: "...", flowId: "...", name: "My Webchat" }
3. The response includes demoWebchatUrl — open it in a browser to test immediately.
4. Always show demoWebchatUrl to the user by default. Only provide configUrl/embeddingSnippet when asked about embedding or production deployment.

Quick Start — Update Existing Webchat

manage_webchat { endpointId: "...", layout: { colors: { primaryColor: "#0052cc" } }, behavior: { renderMarkdown: true } }

CREATE vs UPDATE:

• To create: omit endpointId and provide projectId + flowId. A new webchat3 endpoint is always created.
• To update: provide endpointId. Only the specified fields are changed; everything else is preserved.
• The tool never auto-detects or modifies existing endpoints. To update, first find the endpointId using list_resources { resourceType: "endpoint", projectId }.

Style Presets

Use stylePreset to apply a predefined look in one call:

manage_webchat { endpointId: "...", stylePreset: "modern" }

classic (default)

• Chat window: 460px, bot output max-width: 73%, bot output border: on
• Agent message bg: #ffffff, always scroll, no streaming collation, no progressive rendering, markdown on

modern

• Chat window: 900px, bot output max-width: 100%, bot output border: off
• Agent message bg: #ffffff, scroll to last input, streaming collation on, progressive rendering on, markdown on, input collation on

slick

• Chat window: 600px, bot output max-width: 100%, bot output border: off
• Agent message bg: #cccccc, scroll to last input, streaming collation on, progressive rendering off, markdown on, input collation on