Actions a_form_ui

Form (Widget UI)

Collects structured data from the user via a graphical form rendered in the widget.

What does it do?

Displays an interactive form with buttons and text fields directly in the user's screen.

How does it work?

Renders a visual component (only available on channels like the Web Widget) that the user can fill out and submit with one click.

Why use it?

Improves the experience on web pages: instead of chatting to give their email, the user simply types it in a traditional form inside the chat.

Inputs

name	type
`form_response`	object

Outputs

name	type
`branch`	string
`form_id`	string
`channel_mode`	string
`values`	object
`pending_fields`	array
`errors`	object

Branches

Fixed branches

awaiting — Awaiting
complete — Complete

Configuration

—

Default configuration

{
  "form_id": "form_main",
  "fields": [
    {
      "name": "name",
      "label": "Name",
      "type": "text",
      "required": true
    },
    {
      "name": "email",
      "label": "Email",
      "type": "email",
      "required": true
    }
  ],
  "submit_label": "Continuar",
  "awaiting_branch": "awaiting",
  "complete_branch": "complete"
}

Emitted events

This node does not publish events on the pubsub channel.