HubSpot · Schema

OutputField

An output field returned by the action

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
typeDefinition object Definition of a field's type and configuration
View JSON Schema on GitHub

JSON Schema

hubspot-custom-workflow-actions-output-field-schema.json Raw ↑
{
  "type": "object",
  "description": "An output field returned by 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"
      ]
    }
  },
  "required": [
    "typeDefinition"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "OutputField"
}