Activepieces · Schema

Piece

An Activepieces integration piece

AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

Properties

Name Type Description
name string Piece package name
displayName string Human-readable name
description string Piece description
version string Piece version
iconUrl string Piece icon URL
categories array Piece categories
View JSON Schema on GitHub

JSON Schema

activepieces-piece-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/activepieces/refs/heads/main/json-schema/activepieces-piece-schema.json",
  "title": "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": "string",
      "format": "uri",
      "description": "Piece icon URL"
    },
    "categories": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Piece categories"
    }
  }
}