Fields

Fields define the information the bot collects from the visitor.

The bot collects the information in the same order as the fields appear in the form.

Example

If the fields are:

  1. Name
  2. Email
  3. Phone
  4. Company

The bot will collect the information in that order.

A form must contain at least one field.


Standard Attributes

Standard Attributes provide ready-made fields for common contact information.

Available standard fields include:

Field Label Typical Use
name Full Name Visitor's full name
email Work Email Business email address
phone Phone Number Direct phone number
phoneNumber Phone Number Phone number with country code
company Company Name Company or business name

Standard fields are created as string fields and are required by default.


Phone Number Fields

There are two standard phone-related fields.

Phone

Use phone when you want to collect a direct phone number.

Phone Number

Use phoneNumber when you want the phone number to include a country code.

Choose the option that best matches the information your business needs.


Custom Fields

Custom fields allow you to collect information that is not included in the standard attributes.

Examples

You could create fields such as:

  • Budget
  • Job Title
  • Number of Employees
  • Preferred Date
  • Product Interest
  • Appointment Date

Custom fields can be configured with their own name, label, type, hint, and required/optional setting.


Field Name

The Field Name is the internal name used to identify the information being collected.

Examples:

name
email
company
budget
appointment_date

Every field needs a name.

Field name rules

  • Each field must have a name.
  • Field names must be unique.
  • Names that differ only by capitalisation are still treated as duplicates.

For example, these should not be used together:

email / Email

A duplicate field name can cause a validation error.


Label

The Label is the friendly name associated with a field.

It helps describe what the field represents.

Examples

Field Name Label
email Work Email
company Company Name
budget Budget

The label is optional.


Field Type

The Type determines what kind of information the field collects.

Available types are:

Type Best for
string Text, names, email addresses, or notes
number Numerical information
boolean Yes/No type answers

Examples

Name

string

Email

string

Number of Employees

number

Interested in a Demo?

boolean

Choosing the appropriate type helps ensure the information collected matches what you need.


Agent Hint

An Agent Hint gives the bot additional guidance about a field.

Use it when the bot needs more context about what information to ask for or what format to expect.

Examples

Business email address

Phone with country code

Ask for the customer's company name

Ask for the approximate monthly budget

Agent Hints are optional.


Required and Optional Fields

Each field can be either Required or Optional.

Required

The visitor must provide the information.

Optional

The visitor can continue without providing the information.

Standard attributes are required by default.

New custom fields are optional by default.

Example

For a demo request:

Field Requirement
Name Required
Email Required
Company Optional
Budget Optional

Only make a field required when the information is genuinely necessary.


Field Order

The order of fields determines the order in which the bot collects information.

Example

If your form contains:

  1. Full Name
  2. Email
  3. Phone Number

The bot asks for the visitor's name first, followed by their email and then their phone number.

A good order usually starts with simple information and moves toward more specific information.


Deleting Fields

Fields can be removed when they are no longer needed.

However, every lead form must contain at least one field.

If you attempt to remove the only field, the system displays:

fields must contain at least one lead field.