An object specifying a switch field in an integration's configuration

A switch is a binary input, with a value of either true or false.

Attribute

Description

Example

type
"switch"

Marks this object as being a Settings Switch Field.

"switch"

name
string

Name of this field, for use with your systems.

"enable_polling"

label
string (optional)

Label for the field, visible to the end user. Defaults to the value of name if not set.

"Use Polling"

value
boolean (optional)

The value of the field. Defaults to false.

true

description
string (optional)

Description of the field, displayed to the end user.

"Determines if we will poll Zendesk for updates."

hint
string (optional)

Extra detail that may help the end user with this field.

"Reach out to your customer success manager for details."

validationMessage
string (optional)

An error message indicating that the user has filled in this field incorrectly.

"You must enable polling to use this integration."