HubSpot · JSON Structure

Custom Workflow Actions Api Action Labels Structure

Human-readable labels for the action

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

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

Properties

actionName actionDescription appDisplayName actionCardContent

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-action-labels-structure.json",
  "name": "ActionLabels",
  "description": "Human-readable labels for the action",
  "type": "object",
  "properties": {
    "actionName": {
      "type": "string",
      "description": "The display name of the action",
      "example": "Example Record"
    },
    "actionDescription": {
      "type": "string",
      "description": "A description of what the action does",
      "example": "This is an example description."
    },
    "appDisplayName": {
      "type": "string",
      "description": "The name of the app providing this action",
      "example": "Example Record"
    },
    "actionCardContent": {
      "type": "string",
      "description": "Content to display on the action card in the workflow editor",
      "example": "example-value"
    }
  },
  "required": [
    "actionName"
  ]
}