Chat
Chat is an event source. It exposes an HTTP endpoint at Path and starts a workflow for each request, shaped for conversational exchanges.
What distinguishes it from Form is conversation tracking: Enable Auto Conversation Id carries an identifier across requests so a workflow can tell one conversation from another.
The activity has three tabs: Configuration, Params, and Output.
Configuration
| Field | Required | Description |
|---|---|---|
| Name | Optional | Name of the step, should be unique within this workflow. |
| Description | Optional | Brief description of what this step does. |
| Path | Optional | The API route pattern, optionally containing {} for path parameters. |
| Enable Auto Conversation Id | Optional | Generate and track a conversation identifier automatically. |
| Conversation Id Key | Optional | The key the conversation identifier is read from and written to. Defaults to conversationId. |
Params
| Field | Required | Description |
|---|---|---|
| Query Params | Optional | Query string parameters to append to the request URL. |
| Path Params | Optional | Path variables used in the API path, such as /users/{id}. |
Output
| Field | Required | Description |
|---|---|---|
| Output | Optional | The inbound request, mapped into the workflow. |