An object specifying a text field in an integration's configuration
Attribute | Description | Example |
---|---|---|
type"text" | Marks this object as being a Settings Text Field. | "text" |
name string | Name of this field, for use with your systems. | "first_name" |
label string (optional) | Label for the field, visible to the end user. Defaults to the value of name if not set. | "First Name" |
value string (optional) | The value of the field. | "John" |
description string (optional) | Description of the field, displayed to the end user. | "Your first name as it appears on your driver's license." |
placeholder string (optional) | Placeholder in the input, displayed to the end user. | "Jack" |
hint string (optional) | Extra detail that may help the end user with this field. | "If you don't have a first name, type N/A" |
validationMessage string (optional) | An error message indicating that the user has filled in this field incorrectly. | "First name cannot be blank." |