HubSpot · JSON Structure

Custom Workflow Actions Api Field Type Definition Structure

Definition of a field's type and configuration

Type: object Properties: 6 Required: 2

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

FieldTypeDefinition is a JSON Structure definition published by HubSpot, describing 6 properties, of which 2 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name type fieldType label description options

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/hubspot/refs/heads/main/json-structure/custom-workflow-actions-api-field-type-definition-structure.json",
  "name": "FieldTypeDefinition",
  "description": "Definition of a field's type and configuration",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The programmatic name of the field",
      "example": "Example Record"
    },
    "type": {
      "type": "string",
      "enum": [
        "STRING",
        "NUMBER",
        "BOOL",
        "DATE",
        "DATETIME",
        "ENUMERATION",
        "PHONE_NUMBER",
        "CURRENCY"
      ],
      "description": "The data type of the field",
      "example": "STRING"
    },
    "fieldType": {
      "type": "string",
      "enum": [
        "TEXT",
        "TEXTAREA",
        "NUMBER",
        "SELECT",
        "BOOLEANCHECKBOX",
        "DATE",
        "FILE"
      ],
      "description": "The UI field type for input",
      "example": "TEXT"
    },
    "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",
      "items": {
        "type": "object",
        "description": "An option for an enumeration field",
        "required": [
          "label",
          "value"
        ],
        "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": "int32",
            "description": "Order in which to display the option",
            "example": 100
          }
        }
      },
      "example": [
        {
          "label": "Example Record",
          "value": "example-value",
          "displayOrder": 100
        }
      ]
    }
  },
  "required": [
    "name",
    "type"
  ]
}