ActionDefinitionRevisionCollection

{
  "type": "object",
  "description": "A paginated collection of action definition revisions",
  "properties": {
    "results": {
      "type": "array",
      "description": "List of revisions",
      "example": [
        {
          "revisionId": "500123",
          "definition": {},
          "createdAt": "2025-03-15T14:30:00Z"
        }
      ],
      "items": {
        "type": "object",
        "description": "A revision of an action definition",
        "properties": {
          "revisionId": {
            "type": "string",
            "description": "The unique identifier of the revision",
            "example": "500123"
          },
          "definition": {
            "type": "object",
            "description": "A custom workflow action definition",
            "properties": {
              "id": {
                "type": "string",
                "description": "The unique identifier of the action definition",
                "example": "500123"
              },
              "revisionId": {
                "type": "string",
                "description": "The current revision identifier",
                "example": "500123"
              },
              "actionUrl": {
                "type": "string",
                "description": "The URL that HubSpot will call when the action executes",
                "format": "uri",
                "example": "https://app.hubspot.com/contacts/12345"
              },
              "labels": {
                "type": "object",
                "description": "Human-readable labels for the action",
                "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"
                ]
              },
              "inputFields": {
                "type": "array",
                "description": "Input fields that users can configure for the action",
                "example": [
                  {
                    "typeDefinition": {},
                    "supportedValueTypes": [
                      {}
                    ],
                    "isRequired": true
                  }
                ],
                "items": {
                  "type": "object",
                  "description": "An input field for the action",
                  "properties": {
                    "typeDefinition": {
                      "type": "object"
                    },
                    "supportedValueTypes": {
                      "type": "object"
                    },
                    "isRequired": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "typeDefinition",
                    "supportedValueTypes"
                  ]
                }
              },
              "outputFields": {
                "type": "array",
                "description": "Output fields that the action returns",
                "example": [
                  {
                    "typeDefinition": {}
                  }
                ],
                "items": {
                  "type": "object",
                  "description": "An output field returned by the action",
                  "properties": {
                    "typeDefinition": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "typeDefinition"
                  ]
                }
              },
              "objectTypes": {
                "type": "array",
                "description": "CRM object types this action can operate on",
                "example": [
                  "CONTACT"
                ],
                "items": {
                  "type": "string",
                  "enum": [
                    "CONTACT",
                    "COMPANY",
                    "DEAL",
                    "TICKET",
                    "QUOTE"
                  ]
                }
              },
              "objectRequestOptions": {
                "type": "object",
                "description": "Options for requesting CRM object data",
                "properties": {
                  "properties": {
                    "type": "array",
                    "description": "CRM properties to include in the action execution request",
                    "example": [
                      "example-value"
                    ],
                    "items": {
                      "type": "object"
                    }
                  }
                }
              },
              "published": {
                "type": "boolean",
                "description": "Whether the action is published and available for use",
                "example": true
              },
              "functions": {
                "type": "array",
                "description": "Functions associated with this action",
                "example": [
                  {
                    "functionType": "PRE_ACTION_EXECUTION",
                    "id": "500123"
                  }
                ],
                "items": {
                  "type": "object",
                  "description": "A reference to a function associated with an action",
                  "properties": {
                    "functionType": {
                      "type": "object"
                    },
                    "id": {
                      "type": "object"
                    }
                  },
                  "required": [
                    "functionType",
                    "id"
                  ]
                }
              }
            },
            "required": [
              "id",
              "revisionId",
              "actionUrl",
              "labels",
              "objectTypes"
            ]
          },
          "createdAt": {
            "type": "string",
            "description": "When the revision was created",
            "format": "date-time",
            "example": "2025-03-15T14:30:00Z"
          }
        },
        "required": [
          "revisionId",
          "definition",
          "createdAt"
        ]
      }
    },
    "paging": {
      "type": "object",
      "description": "Pagination information",
      "properties": {
        "next": {
          "type": "object",
          "example": {
            "after": "example-value"
          },
          "properties": {
            "after": {
              "type": "string",
              "description": "Cursor for the next page"
            }
          }
        }
      }
    }
  },
  "required": [
    "results"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "ActionDefinitionRevisionCollection"
}