Skip to main content

Form Event

Controlled node

Overview

The Form Event node listens for user interactions within Intellectible UI forms, such as button clicks or other element actions. When a specified form element triggers an event (e.g., a button press), this node fires its output event, allowing your workflow to respond to user input in real-time.

This node is essential for creating interactive workflows that respond to user actions in custom UI interfaces. It can also capture the index position when events originate from elements inside lists.

Event Handling

The node connects to form elements by referencing:

  • Page: The specific UI page where the element exists
  • Name: The event name configured on the form element (e.g., a button's click event name)

When the specified element fires its event, the Form Event node triggers the fired event output and provides the listIndex data output.

Inputs

InputTypeDescriptionDefault
PageDropDownThe display name of the UI page containing the target element. Must match the page name defined in your form configuration.-
NameDropDownThe event name assigned to the form element (e.g., the event name set on a button component).-

Outputs

OutputTypeDescription
firedEventFires when the specified form element triggers its event (e.g., when a button is clicked).
listIndexDataOutputs the index position when the event originates from an element inside a list. Returns 0 for non-list elements, or an array of indices for nested lists.

Runtime Behavior and Defaults

  • Controlled Execution: This node waits for external form events and does not auto-trigger on workflow start.
  • Event Matching: The node listens for events matching the pattern Form.{pageId}.{eventName}. When a matching event occurs, it fires immediately.
  • List Index Handling: If the event originates from within a list component (e.g., a button inside a repeating list), the node automatically extracts and outputs the index/indices of the clicked item.
  • No Defaults: Both Page and Name inputs must be explicitly configured for the node to function.

Example Usage

Basic Button Click Handler

Connect a Form Event node to respond to a button click in your UI:

  1. Configure the Page input with the name of your UI page (e.g., "MainPage")
  2. Set the Name input to match the button's event name (e.g., "submitButton")
  3. Connect the fired event output to trigger downstream nodes (like AI Write or Database operations)

Handling List Items

When working with repeating lists (like a list of items with individual action buttons):

  1. Place a button inside a list component in your UI
  2. Set the button's event name (e.g., "deleteItem")
  3. Configure the Form Event node with the page name and "deleteItem" as the name
  4. Use the listIndex output to identify which specific list item triggered the event
  5. Connect listIndex to a Get Value or Variable node to retrieve the corresponding data for that index

This pattern is useful for creating dynamic interfaces where users can interact with individual items in a list (editing, deleting, or viewing details).