viaSocket Help

Dictionary

A Dictionary Field allows users to input multiple dynamic key-value pairs. It is the ideal choice for flexible data structures where the keys are not predefined.

#

Common Use Cases

Use the Dictionary Field for data that requires custom or variable naming:

  • Custom Fields: Additional CRM or profile properties.

  • Metadata: Extra context or tagging information.

  • Product Attributes: Dynamic specifications like color, size, or material.

  • Extra API Data: Supplementary payload fields required by specific endpoints.

#

Configuration

Add Field → Select Dictionary

Fill in the details for Key, Label, Help, Placeholder, Required, Visibility Condition.

Use the following JSON structure to define a Dictionary field:

[
  {
    "key": "custom_fields",
    "type": "dictionary",
    "label": "Custom Fields",
    "help": "Enter the custom fields in key-value pairs",
    "required": true,
    "template": {
      "key": {
        "type": "string",
        "placeholder": "Enter key"
      },
      "value": {
        "type": "string",
        "placeholder": "Enter value"
      }
    }
  }
]

Note: The system sends this data as a JSON object of key-value pairs (e.g., {"first_name": "Alex", "company": "Google"}).

Property

Description

Example

Template

Defines the structure and placeholders for dictionary keys and values

Key Placeholder: Enter key
Value Placeholder: Enter value