Step: Show Form

• Key: show-form
• Category: User Interaction
• Description: Attach a form widget to the assistant response message. The form can come from the form library or be defined inline in the step.

Inputs

• formId (select, optional): Existing form to display. Leave empty when using inlineForm.
• inlineForm (object, optional): Flow-specific form definition with title, description, fields, optional submitButtonText, successMessage, theme, and webhooks.
• title (text, optional): Override title for a predefined form.
• description (text, optional): Override description for a predefined form.
• waitForSubmission (boolean, optional): Whether the created form widget should be marked as waiting for submission. Defaults to true.

Either formId or inlineForm is required.

Outputs

• messageWidgetId (string): ID of the created form widget instance.
• formId (string | null): Existing form ID, or null for inline forms.
• formTitle (string): Title of the displayed form.
• waitingForSubmission (boolean): Whether the form widget is waiting for user submission.

Notes

• This step creates a message widget on the current assistant response. It requires conversation/message context, so it is intended for peer/chat executions.
• The step returns widget metadata. It does not directly return a submission object as the next step output.
• Inline forms support conditional field visibility through showWhen rules.
• Use this step when the user needs to fill a structured form in the chat UI.

Example Use Case

1. A user asks to submit a support ticket.
2. The Flow reaches show-form and attaches a support form widget to the response message.
3. The user fills in the widget in the chat UI.
4. Downstream handling can use the form submission system or webhooks configured on the form.