viaSocket Help

Text Input Field



A Text Input Field allows users to enter text manually or map text values from previous workflow steps.

Use it when an API expects a string value as input.


#

When to use a Text Input Field?

Use a Text Field when users need to provide information such as:

  • First Name

  • Last Name

  • Email Address

  • Company Name

  • City

  • Subject

  • Notes

  • Description

  • Reference ID

  • Tags or Labels


#

How to add a Text Field?

#

Step 1 - Click "ADD FIELD"

Inside the Action Builder, open the ADD FIELD dropdown.

#

Step 2 - Select "Text"

Choose Text from the list of available field types.

#

Step 3 - Configure the Field

Fill in the field details:


[
  {
    "key": "first_name",
    "label": "First Name",
    "placeholder": "Ravi",
    "type": "string",
    "required": true
  }
]

Property

Description

Example

Type

string

string

Label

Field name shown to users

First Name

Key

API parameter name

first_name

Required

Makes the field mandatory

Yes / No

Placeholder

Example value shown inside the field

Ravi

Help

Text displayed on hover for user guidance

Enter your first name

Additionally, attributes like defaultValue, visibilityCondition, list, limit, help can be used as per need and requirement.

#

Step 4 - Save the Field

Click anywhere outside the configuration panel to automatically save the field.


#

Example

Label

Key

Required

First Name

first_name

Yes

Last Name

last_name

Yes

City

city

No

These values can then be used directly in the API request during workflow execution.