HubSpot · JSON Structure

Custom Workflow Actions Api Output Field Structure

An output field returned by the action

Type: object Properties: 1 Required: 1
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

OutputField is a JSON Structure definition published by HubSpot, describing 1 property, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

typeDefinition

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

JSON Structure

Raw ↑ 
{
  "$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-output-field-structure.json",
  "name": "OutputField",
  "description": "An output field returned by the action",
  "type": "object",
  "properties": {
    "typeDefinition": {
      "type": "object",
      "description": "Definition of a field's type and configuration",
      "required": [
        "name",
        "type"
      ],
      "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": {
            "$ref": "#/components/schemas/FieldOption"
          },
          "example": [
            {
              "label": "Example Record",
              "value": "example-value",
              "displayOrder": 100
            }
          ]
        }
      }
    }
  },
  "required": [
    "typeDefinition"
  ]
}