HubSpot · Schema

ActionResponse

Response for asynchronous action status

AnalyticsCommerceContentCRMCustomer ServiceEmail MarketingMarketingMarketing AutomationOperationsSales

Properties

Name Type Description
status string Current status of the action
requestedAt string When the action was requested
startedAt string When the action started processing
completedAt string When the action completed
links object Related links
View JSON Schema on GitHub

JSON Schema

hubspot-source-code-action-response-schema.json Raw ↑ 
{
  "type": "object",
  "description": "Response for asynchronous action status",
  "properties": {
    "status": {
      "type": "string",
      "description": "Current status of the action",
      "example": "COMPLETE",
      "enum": [
        "PENDING",
        "PROCESSING",
        "CANCELED",
        "COMPLETE"
      ]
    },
    "requestedAt": {
      "type": "string",
      "description": "When the action was requested",
      "format": "date-time",
      "example": "2024-01-15T10:30:00Z"
    },
    "startedAt": {
      "type": "string",
      "description": "When the action started processing",
      "format": "date-time",
      "example": "2024-01-15T10:30:01Z"
    },
    "completedAt": {
      "type": "string",
      "description": "When the action completed",
      "format": "date-time",
      "example": "2024-01-15T10:30:15Z"
    },
    "links": {
      "type": "object",
      "description": "Related links",
      "example": {
        "key": "value"
      }
    }
  },
  "required": [
    "status",
    "startedAt",
    "completedAt"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ActionResponse"
}