Activepieces · JSON Structure

Activepieces Flow Structure

An Activepieces automation flow

Type: object Properties: 9
AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

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

Properties

id created updated projectId externalId displayName status folderId publishedVersionId

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/activepieces/refs/heads/main/json-structure/activepieces-flow-structure.json",
  "name": "Flow",
  "description": "An Activepieces automation flow",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique flow identifier",
      "example": "flow-abc123"
    },
    "created": {
      "type": "datetime",
      "description": "Creation timestamp",
      "example": "2025-03-15T14:30:00Z"
    },
    "updated": {
      "type": "datetime",
      "description": "Last updated timestamp",
      "example": "2025-03-15T14:30:00Z"
    },
    "projectId": {
      "type": "string",
      "description": "Associated project ID",
      "example": "project-xyz789"
    },
    "externalId": {
      "type": "string",
      "description": "External ID for the flow"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable flow name",
      "example": "Send Welcome Email"
    },
    "status": {
      "type": "string",
      "enum": [
        "ENABLED",
        "DISABLED"
      ],
      "description": "Flow status",
      "example": "ENABLED"
    },
    "folderId": {
      "type": "string",
      "description": "Folder ID if organized in a folder"
    },
    "publishedVersionId": {
      "type": "string",
      "description": "ID of the published version"
    }
  }
}