> ## Documentation Index
> Fetch the complete documentation index at: https://chatbase.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Collect custom details from customers in chat

> Have your AI agent gather any custom fields you define from the customer, conversationally, mid-chat

The Chatbase Collect Data Action lets your AI agent gather any custom information you define, such as a shipping address, an order number or feedback, from the customer during a conversation. It's for teams that need structured details from customers without sending them to a separate form. There's no form: the AI agent asks for the missing fields in chat on every channel and saves the submission once it has everything required.

> [card] Best for:
>
> Collecting structured details (a shipping address, feedback, an application) without interrupting the conversation with a form.

**Common Use Cases:**

* Collecting a shipping address before arranging a delivery
* Gathering feedback details after a support interaction
* Capturing the specifics of a request your team will act on later

> [!TIP]
>
> You can create more than one Collect Data Action on the same AI agent, each with its own name, fields, and destinations. For example, one Action to collect a shipping address and a separate one to collect feedback details.

## How to create the Action

**1. Navigate to Actions**

Go to your [Chatbase dashboard](https://www.chatbase.co/dashboard/) and select your AI agent. Click **Build > Actions** in the left sidebar.

**2. Create the Action**

Click **Create Action**, then select **Collect Data**.

**3. Configure General Settings**

**Action Name:** A descriptive name for this Action. It doubles as the identifier for this Action's webhook events, so it must be unique across your AI agent's Actions. Renaming the Action later changes its webhook event name, so update any webhook receivers that filter on it.

**When to use:** Explain when the AI agent should collect this data from the customer. Include a description of what information is collected and its purpose, and add example queries that should trigger this Action.

To restrict the Action to [Procedure](https://chatbase.co/docs/user-guides/chatbot/procedures/procedures-overview.md) steps only, turn on [**Only use in Procedures**](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md#only-use-in-procedures). When it's on, the **When to use** field is hidden, because the AI agent no longer decides when to call the Action.

**4. Define your fields**

In the **Fields** section, list the data the AI agent should collect. See [Fields](#fields) below.

**5. Set your destinations**

In **Destinations**, choose where collected data should be sent. See [Destinations](#destinations) below. This step is optional.

**6. Choose Channels**

This Action is compatible with every channel. Toggle it on or off for each configured channel. See [Channels](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md#channels) for what configured, unconfigured, and incompatible mean.

**7. Enable and Test**

Preview your settings in the AI agent on the Action page, then click **Enable**.

## Fields

In the **Fields** section, list the data the AI agent should collect from the customer during the conversation. Each field has a name, a type (text, number, email, date, or boolean), a description that tells the AI agent what to ask for, and a **Required** checkbox. You can add up to 20 fields.

The AI agent asks for all required fields before saving the submission; optional fields are saved when the customer provides them but never block the save. The AI agent never invents values: it only saves what the customer has explicitly provided. Each time the AI agent completes a collection it's saved as its own submission, so if the Action runs more than once in a conversation you get one submission per run.

Collected data appears under **Activity > Collected data**, where each field gets its own column. Fields are also included in CSV and PDF exports and in the [`{action name}_collect_data.submit` webhook](https://chatbase.co/docs/developer-guides/webhooks).

### Field validation

Values are checked against the field type before anything is saved:

| Type | What's accepted |
| - | - |
| **Text** | Any text |
| **Number** | A number |
| **Boolean** | Yes or no (true or false) |
| **Date** | A date in `yyyy-mm-dd` format |
| **Email** | A valid email address |

If a value doesn't match, nothing is saved and the AI agent receives an error instead. For example, an invalid email tells the AI agent "Not a valid email. Ask the user to provide a valid email address."

### Example: collecting a shipping address

Example configuration: an Action named `shipping_address` with required text fields `street`, `city` and `postal_code`, an optional text field `delivery_notes`, and **When to use** set to "When the customer wants to change where their order is delivered."

> **Customer:** I moved. Can you send my order to my new address?
>
> **AI agent:** Sure. What's the street address?
>
> **Customer:** 12 Market Street, Springfield, 01101.
>
> **AI agent:** Thanks. Any delivery notes, like a gate code?
>
> **Customer:** No, that's all.
>
> **AI agent:** Got it. I've saved your new address, and our team will update your delivery.

The submission appears under **Activity > Collected data** with `street`, `city` and `postal_code` filled in, and fires the `shipping_address_collect_data.submit` webhook.

> [!TIP]
>
> The chat shows no built-in confirmation when a submission is saved. The AI agent writes its own reply, so if you want a specific confirmation, say so in **When to use**, for example "After saving, confirm the address back to the customer."

## Destinations

Use **Destinations** to specify where collected data should be sent. You can skip this step if you don't want to send collected data anywhere external.

### Webhooks

Add one or more webhook endpoints to receive each submission as a `POST` request.

**1. Expand Destinations**

Open the **Destinations** section of the Action.

**2. Enter the endpoint URL**

Add the URL that should receive the submission.

**3. Create the webhook**

Click **Create webhook**.

### Email notifications

Enable **Email notification** to receive an email every time data is collected through this Action. You can add one or more email addresses, and each successful submission triggers an email containing the collected data.

> [!NOTE]
>
> Email notifications are not available for HIPAA accounts. On HIPAA accounts, collected field values are also redacted before they're stored.

> [!TIP]
>
> Test the Action by having a conversation that should trigger it, and confirm the submission appears under **Activity > Collected data** with every field populated.

## Channels

The Collect Data Action is compatible with every channel. Use **Channels** in the Action's configuration to enable or disable it per channel. See [Channels](https://chatbase.co/docs/user-guides/chatbot/actions/actions-overview.md#channels) for what configured, unconfigured, and incompatible mean.

## Limitations

* **Up to 20 fields per Action.** If you need more, split the collection across separate Collect Data Actions.
* **Always conversational.** There's no form mode, so the AI agent always asks for fields in chat.
* **No choice-list field type.** Fields can be text, number, email, date or boolean.
* **Email notifications are unavailable on HIPAA accounts,** where field values are also redacted before storage. The Action itself is available on HIPAA accounts.

## Best Practices

> [card] Write Clear Field Descriptions
>
> The description tells the AI agent what to ask for. A vague description produces a vague question and a wrong answer.

> [card] Require Only What You Need
>
> Every required field is another thing the customer must supply before the submission saves. Mark the rest optional.

> [card] Use Natural Language
>
> Keep **When to use** instructions short and simple, start with action verbs, and say what you want the AI agent to do rather than what to avoid.

> [card] Split by Purpose
>
> Create a separate Action per kind of data you collect, so each has its own fields, destinations, and webhook identity.

## Frequently asked questions

> [accordion] What's the difference between Collect Data and Collect Leads?
>
> [Collect Leads](https://chatbase.co/docs/user-guides/chatbot/actions/collect-leads.md) captures contact details (name, email, phone number and optional custom fields), can show a form, and saves to **Activity > Leads**. Each AI agent has one. Collect Data gathers any fields you define, always conversationally, saves to **Activity > Collected data**, and you can create several, each with its own name and webhook event.

> [accordion] Does the customer see a confirmation when the data is saved?
>
> Not automatically. No confirmation card is shown in the chat. The AI agent writes its own reply after saving, so add confirmation instructions to **When to use** if you want a consistent message.

> [accordion] Are values checked against the field type?
>
> Yes. Numbers must be numbers, booleans must be true or false, dates must be `yyyy-mm-dd`, and emails must be valid. If a value doesn't match, nothing is saved and the AI agent receives an error, so it can ask the customer for a corrected value. Text fields accept anything.

> [accordion] Does collected data create or update a Contact?
>
> No. Submissions are stored separately under **Activity > Collected data** and sent to this Action's webhooks and email notifications. They don't touch [Contacts](https://chatbase.co/docs/user-guides/chatbot/contacts/contacts-overview.md) or the leads list.

> [accordion] Does Collect Data count toward my plan's Action limit?
>
> Yes. Every enabled Collect Data Action counts toward your plan's Actions-per-agent limit, like any other Action. It has no other plan restriction and is available on HIPAA accounts.

> [accordion] What happens if I rename the Action?
>
> The webhook event name includes the Action name (`{action name}_collect_data.submit`), so renaming the Action changes the event your webhook receives. Update any receiver that checks the event name.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.