Activepieces · JSON Structure

Activepieces Piece Structure

An Activepieces integration piece

Type: object Properties: 6
AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

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

Properties

name displayName description version iconUrl categories

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-piece-structure.json",
  "name": "Piece",
  "description": "An Activepieces integration piece",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Piece package name",
      "example": "@activepieces/piece-github"
    },
    "displayName": {
      "type": "string",
      "description": "Human-readable name",
      "example": "GitHub"
    },
    "description": {
      "type": "string",
      "description": "Piece description"
    },
    "version": {
      "type": "string",
      "description": "Piece version",
      "example": "0.5.0"
    },
    "iconUrl": {
      "type": "uri",
      "description": "Piece icon URL"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Piece categories"
    }
  }
}