Activepieces · Schema

Connection

An app connection (credentials for a third-party service)

AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

Properties

Name Type Description
id string Connection ID
created string
updated string
name string Connection name
pieceName string Integration piece name
projectId string Project ID
status string Connection status
type string Authentication type
View JSON Schema on GitHub

JSON Schema

activepieces-connection-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-connection-schema.json",
  "title": "Connection",
  "description": "An app connection (credentials for a third-party service)",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Connection ID",
      "example": "conn-abc123"
    },
    "created": {
      "type": "string",
      "format": "date-time"
    },
    "updated": {
      "type": "string",
      "format": "date-time"
    },
    "name": {
      "type": "string",
      "description": "Connection name",
      "example": "My Gmail Account"
    },
    "pieceName": {
      "type": "string",
      "description": "Integration piece name",
      "example": "@activepieces/piece-gmail"
    },
    "projectId": {
      "type": "string",
      "description": "Project ID"
    },
    "status": {
      "type": "string",
      "enum": [
        "ACTIVE",
        "ERROR",
        "EXPIRED"
      ],
      "description": "Connection status",
      "example": "ACTIVE"
    },
    "type": {
      "type": "string",
      "enum": [
        "OAUTH2",
        "API_KEY",
        "BASIC_AUTH",
        "CUSTOM_AUTH"
      ],
      "description": "Authentication type"
    }
  }
}