Documentation Index
Fetch the complete documentation index at: https://docs.lyzn.ai/llms.txt
Use this file to discover all available pages before exploring further.
Chat
Triggered by chat messages over WebSocket
Properties
| Property | Value |
|---|
| Type | chat-trigger |
| Family | Triggers |
| Group | General |
Parameters
| Name | Label | Type | Description | Required |
|---|
| chatName | Chat Name | String | This is the name of your chat | Yes |
| initialMessage | Initial Message | String | This is the initial message of your chat | No |
| showInitialMessage | Show Initial Message | Bool | Whether to show the initial message | Yes |
| primaryColor | Primary Color | String | Primary theme color for chat UI (hex format, e.g., #226326) | No |
| secondaryColor | Secondary Color | String | Secondary/accent color for chat UI (hex format, e.g., #2B7D30) | No |
| showSuggestions | Show Suggestions | Bool | Whether to show quick suggestion bubbles above chat input | No |
| suggestions | Suggestions | JSON | Quick suggestion bubbles - array of {title: string, message: string} | No |
| inputPlaceholder | Input Placeholder | String | Placeholder text shown in the chat input field | No |
| enableFileUpload | Enable File Upload | Bool | Allow users to upload files in chat | No |
| allowedFileTypes | Allowed File Types | String | Comma-separated MIME types or categories: image, document, audio, video, or specific types like image/png | No |
| maxFileCount | Max Files Per Message | Number | Maximum number of files that can be uploaded per message (0 = unlimited) | No |
| maxFileSizeMB | Max File Size (MB) | Number | Maximum file size in megabytes per file (0 = unlimited) | No |
Outputs
| Name | Label | Type | Description |
|---|
| message | message | string | Incoming chat message |
| sessionId | sessionId | string | Chat session identifier |
| chatNodeId | chatNodeId | string | ID of the chat trigger node (for history lookup) |
| senderId | senderId | string | Message sender identifier |
| metadata | metadata | object | Additional metadata |
| receivedAt | receivedAt | string | Timestamp when the message was received |
| files | files | array | Array of uploaded file URLs |