# Chat - Workflow trigger | Docs - nodulz

Source: https://nodulz.com/docs/nodes/chat

Language: en

Triggers the workflow from a test chat window or a public page

## Usage and specifics

The editor provides a test chat. publicEnabled and embedEnabled separately enable the public page and embedding. Response mode, template and history configure the conversation.

Technical type : `chat`. Runtime : `nodulz`.

## Credentials and prerequisites

This node defines no dedicated external credential. Remote sources or execution targets may still need their own access credentials.

See the [credentials guide](/docs/credentials) if a remote source or execution target requires access.

## Parameters

Names below are technical keys. Defaults are not a ready-to-run configuration: complete fields required by your operation. Paths containing [] describe list items; some fields depend on the selected mode.

| Parameter | Type | Default | Values / limits |
| --- | --- | --- | --- |
| `rateLimitEnabled` | `boolean` | - | - |
| `rateLimitMax` | `number` | `30` | -; > 0 |
| `rateLimitWindowMs` | `number` | `60000` | -; > 0 |
| `allowedIps` | `array` | - | -; max 256 |
| `blockedIps` | `array` | - | -; max 256 |
| `path` | `string` | `""` | - |
| `publicEnabled` | `boolean` | `false` | - |
| `embedEnabled` | `boolean` | `false` | - |
| `attachmentsEnabled` | `boolean` | `false` | - |
| `attachmentsMaxFiles` | `number` | `5` | -; ≥ 0 |
| `attachmentMaxSizeMb` | `number` | `5` | -; ≥ 0 |
| `attachmentsMaxTotalSizeMb` | `number` | `25` | -; ≥ 0 |
| `authentication` | `enum` | `"none"` | `none`, `secret` |
| `secret` | `string` | - | - |
| `title` | `string` | `"Chat"` | - |
| `welcomeMessage` | `string` | `""` | - |
| `inputPlaceholder` | `string` | `""` | - |
| `avatarUrl` | `string` | `""` | - |
| `primaryColor` | `string` | `"#6366f1"` | - |
| `backgroundColor` | `string` | `"#ffffff"` | - |
| `userBubbleColor` | `string` | `"#6366f1"` | - |
| `assistantBubbleColor` | `string` | `"#f1f5f9"` | - |
| `historyEnabled` | `boolean` | `true` | - |
| `historyMaxMessages` | `number` | `50` | -; > 0 |
| `respond` | `enum` | `"streaming"` | `streaming`, `when_finished` |
| `responseFormat` | `enum` | `"node_output"` | `template`, `last_node`, `node_output`, `response_node` |
| `respondNodeKey` | `string` | - | - |
| `responseTemplate` | `string` | `""` | - |

## Configuration help

| Setting | Purpose and guidance |
| --- | --- |
| `path`<br>Public path | Unique URL slug (e.g. my-agent → /c/my-agent). Lowercase letters, digits and hyphens only. |
| `publicEnabled`<br>Expose a public page | Enables the /c/{path} page accessible without nodulz authentication. |
| `embedEnabled`<br>Allow iframe embedding | Enables the /embed/c/{path} variant for embedding the chat on external sites. |
| `authentication`<br>Authentication | Protects public routes. Secret is sent via x-nodulz-secret header or ?secret=. |
| `secret`<br>Shared secret | Shared secret for authorized clients. Same mechanism as nodulz webhooks. |
| `attachmentsEnabled`<br>Allow attachments | Allow files to be sent with messages. Files are available in attachments in the node output. |
| `attachmentsMaxFiles`<br>Maximum files per message | Maximum files per message. 0 means unlimited. |
| `attachmentMaxSizeMb`<br>Maximum size per file (MB) | Maximum size in MB per file. 0 means unlimited. |
| `attachmentsMaxTotalSizeMb`<br>Maximum total size per message (MB) | Maximum combined size in MB of all files in a message. 0 means unlimited. |
| `historyEnabled`<br>Keep multi-turn history | Stores previous messages and sends them to the workflow on each new message. |
| `historyMaxMessages`<br>Max messages per session | Limits how many messages are loaded from history (most recent first). |
| `title`<br>Title | Title shown in the public chat header. |
| `welcomeMessage`<br>Welcome message | First message shown by the assistant before any interaction. |
| `inputPlaceholder`<br>Input placeholder | Hint text in the message input area. |
| `avatarUrl`<br>Avatar URL | Image shown next to assistant messages (absolute URL). |
| `primaryColor`<br>Primary color | Accent color for the title and interactive elements on the public page. |
| `backgroundColor`<br>Background color | Chat panel background on the public page. |
| `userBubbleColor`<br>User bubble | Background color for user-sent messages. |
| `assistantBubbleColor`<br>Assistant bubble | Background color for assistant replies. |
| `respond`<br>Respond | Streaming: progressive response during execution. When finished: single response once the workflow completes. |
| `respondNodeKey`<br>Streaming node | Node whose streaming output feeds the real-time chat response. |
| `responseFormat`<br>Response format | Source of the final response when « when finished » mode is selected. |
| `respondNodeKey`<br>Response node | Node whose JSON/text output becomes the assistant reply. |
| `responseTemplate`<br>Response template | Handlebars template applied to workflow output to format the response. |

## Initial configuration

Initial catalog configuration example, to adapt before running. Keep secrets in credentials.

```json
{
  "path": "",
  "publicEnabled": false,
  "embedEnabled": false,
  "authentication": "none",
  "title": "Chat",
  "welcomeMessage": "",
  "inputPlaceholder": "",
  "avatarUrl": "",
  "primaryColor": "#6366f1",
  "backgroundColor": "#ffffff",
  "userBubbleColor": "#6366f1",
  "assistantBubbleColor": "#f1f5f9",
  "historyEnabled": true,
  "historyMaxMessages": 50,
  "respond": "streaming",
  "responseFormat": "node_output",
  "responseTemplate": ""
}
```

## Verification

Test with representative data. Check node output in the inspector and logs, then use editor mapping for downstream fields. A trigger test with a simulated payload does not validate external service delivery.

See also : [Expressions and data](/docs/expressions), [Executions](/docs/executions), [Node catalog](/docs/nodes).

## Explore further

- [Features - nodulz](https://nodulz.com/product/overview)
- [Node catalog - nodulz](https://nodulz.com/product/catalog)
- [MCP server - nodulz](https://nodulz.com/product/mcp)
- [Pricing - nodulz](https://nodulz.com/pricing)
- [Use cases and workflow automation - nodulz](https://nodulz.com/use-cases)
- [Choose what your workflows can do. - nodulz](https://nodulz.com/compare)
- [Documentation - nodulz](https://nodulz.com/docs)