HubSpot · JSON Structure

Custom Workflow Actions Api Batch Callback Response Structure

Response from a batch callback completion operation

Type: object Properties: 2
AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

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

Properties

status errors

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-batch-callback-response-structure.json",
  "name": "BatchCallbackResponse",
  "description": "Response from a batch callback completion operation",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "COMPLETE",
        "PARTIAL"
      ],
      "description": "Overall status of the batch operation",
      "example": "COMPLETE"
    },
    "errors": {
      "type": "array",
      "description": "List of errors for failed callbacks",
      "items": {
        "type": "object",
        "description": "Error information for a failed callback",
        "required": [
          "callbackId",
          "message",
          "category"
        ],
        "properties": {
          "callbackId": {
            "type": "string",
            "description": "The callback that failed",
            "example": "500123"
          },
          "message": {
            "type": "string",
            "description": "Error message",
            "example": "This is an example description."
          },
          "category": {
            "type": "string",
            "description": "Error category",
            "example": "standard"
          }
        }
      },
      "example": [
        {
          "callbackId": "500123",
          "message": "This is an example description.",
          "category": "standard"
        }
      ]
    }
  }
}