Skip to main content

Documentation: Field Types

Fields are key elements in defining the stages of an interactive flow. Each field represents a data entry or an action that the user can perform during the interaction. Fields can be of different types and have specific properties that define their behavior and appearance in the interface.

Field Types​

1. Text​

  • Type: text
  • Description: Simple text field for entering alphanumeric data.

2. Number​

  • Type: number
  • Description: Numeric field for entering numerical values.

3. Email​

  • Type: email
  • Description: Field for entering email addresses.

4. Phone​

  • Type: phone
  • Description: Field for entering phone numbers.

5. Mobile Phone​

  • Type: mobile_phone
  • Description: Field for entering mobile phone numbers.

6. Boolean​

  • Type: boolean
  • Description: Binary selection field (true/false).

7. Date​

  • Type: date
  • Description: Field for entering dates.

8. Time​

  • Type: time
  • Description: Field for entering times.

9. Date and Time​

  • Type: datetime
  • Description: Field for entering dates and times.

10. Password​

  • Type: password
  • Description: Field for entering passwords.

11. URL​

  • Type: url
  • Description: Field for entering web addresses.

12. Void​

  • Type: void
  • Description: Field without value, used for actions or informational messages.

13. Location​

  • Type: location
  • Description: Field for entering a geographically located object.

Location fields have the following structure:

{
   "lat": 40.4561038690257,
   "lng": -3.87168497563809,
   "meta": {}
}

Where:

  • lat (number): Latitude of the location.
  • lng (number): Longitude of the location.
  • meta (object): Additional metadata of the location.

14. Availability​

  • Type: availability
  • Description: Field for selecting dates and times from a list of availability.

Availability fields have the following structure:

{
   "datetime": "2024-05-07T03:21:42.039Z",
   "meta": {
      "owners": ["OWNER-UUID"],
      "assets": ["ASSET-UUID"]
   }
}

Where:

  • datetime (string): Selected date and time.
  • meta (object): Additional metadata of the availability.
  • meta.owners (string[]): Array of owner UUIDs.
  • meta.assets (string[]): Array of asset UUIDs.