HubSpot · Schema

InputField

An input field for the action

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
typeDefinition object Definition of a field's type and configuration
supportedValueTypes array The types of values that can be provided for this field
isRequired boolean Whether this field is required
View JSON Schema on GitHub

JSON Schema

hubspot-custom-workflow-actions-input-field-schema.json Raw ↑
{
  "type": "object",
  "description": "An input field for the action",
  "properties": {
    "typeDefinition": {
      "type": "object",
      "description": "Definition of a field's type and configuration",
      "properties": {
        "name": {
          "type": "string",
          "description": "The programmatic name of the field",
          "example": "Example Record"
        },
        "type": {
          "type": "string",
          "description": "The data type of the field",
          "example": "STRING",
          "enum": [
            "STRING",
            "NUMBER",
            "BOOL",
            "DATE",
            "DATETIME",
            "ENUMERATION",
            "PHONE_NUMBER",
            "CURRENCY"
          ]
        },
        "fieldType": {
          "type": "string",
          "description": "The UI field type for input",
          "example": "TEXT",
          "enum": [
            "TEXT",
            "TEXTAREA",
            "NUMBER",
            "SELECT",
            "BOOLEANCHECKBOX",
            "DATE",
            "FILE"
          ]
        },
        "label": {
          "type": "string",
          "description": "Human-readable label for the field",
          "example": "Example Record"
        },
        "description": {
          "type": "string",
          "description": "Description of the field",
          "example": "This is an example description."
        },
        "options": {
          "type": "array",
          "description": "Options for enumeration fields",
          "example": [
            {
              "label": "Example Record",
              "value": "example-value",
              "displayOrder": 100
            }
          ],
          "items": {
            "type": "object",
            "description": "An option for an enumeration field",
            "properties": {
              "label": {
                "type": "string",
                "description": "Display label for the option",
                "example": "Example Record"
              },
              "value": {
                "type": "string",
                "description": "The value of the option",
                "example": "example-value"
              },
              "displayOrder": {
                "type": "integer",
                "description": "Order in which to display the option",
                "example": 100
              }
            },
            "required": [
              "label",
              "value"
            ]
          }
        }
      },
      "required": [
        "name",
        "type"
      ]
    },
    "supportedValueTypes": {
      "type": "array",
      "description": "The types of values that can be provided for this field",
      "example": [
        "STATIC_VALUE"
      ],
      "items": {
        "type": "string",
        "enum": [
          "STATIC_VALUE",
          "OBJECT_PROPERTY",
          "OUTPUT_FROM_PREVIOUS_ACTION"
        ]
      }
    },
    "isRequired": {
      "type": "boolean",
      "description": "Whether this field is required",
      "example": true
    }
  },
  "required": [
    "typeDefinition",
    "supportedValueTypes"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "InputField"
}