Skip to main content
The Collect Data action lets your AI agent gather any custom information you define from the user, conversationally, mid-chat. There’s no form: the agent asks for the missing fields naturally in the conversation and saves the submission once it has everything required. You can create more than one Collect Data action on the same 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. 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 agent’s actions. When to use: Explain when the AI agent should collect this data from the user. Include a description of what information is collected and its purpose, and add example queries that should trigger this action. Best Practices for Instructions
  • Make sure to use natural language.
  • Keep the sentences short and simple.
  • Include examples that show the model what a good response looks like.
  • Focus on what you’d like the bot to do rather than what to avoid. Start your prompts with action-oriented verbs, e.g., generate, create, and provide.

​
Fields

In the Fields section, list the data the AI agent should collect from the user during the conversation. Each field has a name, a type (text, number, email, date, or boolean), a description that tells the AI what to ask for, and a required checkbox. You can add up to 20 fields. The AI asks for all required fields before saving the submission; optional fields are saved when the user provides them but never block the save. The AI never invents values: it only saves what the user has explicitly provided. Each time the agent completes a collection it is 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.

​
Destinations

Use Destinations to specify where collected data should be sent.

​
Webhooks

Add one or more webhook endpoints to receive each submission as a POST request. To add a webhook:
  1. Expand Destinations.
  2. Enter the endpoint URL.
  3. Click Create webhook.
  4. Save your changes.
You can also skip this step if you do not want to send collected data to an external endpoint.

​
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 will trigger an email containing the collected data.
Email notifications are not available for HIPAA accounts. On HIPAA accounts, collected field values are also redacted before they’re stored.

​
Channels

Use Channels to control where the Collect Data action is available. Enable or disable the action for each configured channel, such as:
  • Chat bubble
  • Center stage
  • Side panel
  • Help page
  • Instagram
  • Messenger
  • WhatsApp
Some channels may be incompatible with the action and will not be available for selection. After choosing the supported channels, click Save.
After you’re done editing, you can preview all your settings in the AI agent found on the Action page. Finally, press the Save and enable button and your action will be live ready for your agent to serve to users.