Skip to main content

Add an item to a list tool

Creates a new record in the selected data list when used by the AI Agent.

Updated today

The Add an item to a list tool enables an AI Agent to create a new record in a selected data list. By configuring the input fields and outputs, you define how the agent supplies data and how the system returns the result of the creation.


Accessing the Tools Page

  1. Open the target AI Agent.

  2. Click Tools in the top navigation.

  3. View, enable/disable, edit, or delete existing tools.

  4. Click Add a tool to create a new tool.


Adding the “Add an item to a list” Tool

After clicking Add a tool, select:

Add an item to a list — Insert a new record into a data list

Then:

  • Choose application – select the application containing the data list

  • Data source – select the list where the new item will be created

  • Choose Add or Add and configure


General Settings

The configuration page includes general tool settings such as:

  • Detail – Name, Description, Tool type, Application, Data source

  • Credentials to use – End user credentials or Specific user

These settings work the same way as other tools.
For more details, refer to: AI agent.


Inputs – Fields Used When Creating a New Item

Unlike Query items, the Add an item to a list tool requires defining which list fields the agent may fill when creating a new record.

Initially, the Inputs table is empty.
Click + Add input to add fields.

Select inputs

The popup dialog lists all fields from the selected data list:

  • Input name – display name of the field

  • ID – internal field ID

  • Input type – data type (Single line, Number, Date, etc.)

Select the fields that should be available for the agent to populate, then click OK.

Inputs table configuration

Each selected input appears as a row with:

Column

Description

Input name

Name of the field the agent will fill

Input type

Data type inherited from the list

Fill using

AI-generated value or Custom value

Value

Shown only when using Custom value

Notes:

  • Required list fields should be included.

  • Only fields added here can be populated by the agent.

  • Fields can be removed anytime using the delete icon.


Completion

You can configure:

  • After running – whether the agent waits for the tool’s response

This section behaves the same as other tools and works with Outputs to define post-execution behavior.


Outputs available to the agent and other tools

Defines which outputs from this tool will be available for use by the agent or other tools after an item is created.

Default outputs include:

Output

Output type

Description

Message

Text

Describes the execution result (success or error).

Status Code

Number

Indicates success or failure numerically.

Managing outputs

  • Click Customize to configure each output’s content.

  • You may delete outputs you do not need.

  • Deleted outputs can be added back anytime using the Add output button.


Summary

The Add an item to a list tool enables AI Agents to create new records through structured inputs mapped to list fields. By configuring inputs and outputs, you maintain full control over how data is collected and how results are used in follow-up processes.

Did this answer your question?