Enable Chat on a Workflow

A workflow becomes chat-enabled when its trigger is New Chat Request. This is the canonical chat trigger: it's a webhook that runs the workflow synchronously and hands it a message, a conversation id, and any attachments.

Add the trigger

1. Open the workflow in the Workflow Editor.
2. Add or replace the trigger — choose New Chat Request from the trigger palette.
3. Configure the Mode (see below).
4. Save and deploy.

Once deployed, the workflow becomes selectable as a workflow chat: in Enterprise Edition it appears under the Workflows cascade of the AI Hub composer's provider popup, labelled project — workflow; in Community Edition it appears on the standalone Chats page, grouped under its project.

The request shape

The New Chat Request trigger receives a JSON body shaped like:

{
  "conversationId": "a stable id for the conversation",
  "message": "the user's text",
  "attachments": [
    {"file_entry": {}}
  ]
}

• conversationId ties successive turns together so the workflow (and any chat memory) can keep context across messages.
• message is the user's text for this turn.
• attachments carries any files the user uploaded (see Start a workflow chat).

Because the trigger runs synchronously, whatever the workflow returns becomes the reply shown in the chat.

Hosted vs. embedded

The trigger's Mode decides where the chat is consumed:

Pick Hosted Chat when you want ByteChef to provide the chat UI, and Embedded Chat when you're building the front end yourself and just want the trigger contract.

Workflows with multiple triggers

A workflow can have more than one trigger — for example a New Chat Request trigger and a Slack trigger on a specific channel. When a user picks the workflow from the Workflows cascade, the chat is bound to the chat trigger specifically. Other triggers on the same workflow keep firing independently from their own sources.