Activepieces · JSON Structure

Activepieces Upsert Connection Request Structure

Request body for creating or updating a connection

Type: object Properties: 5 Required: 5
AutomationNo-CodeOpen SourceWorkflowAI AgentsMCP

UpsertConnectionRequest is a JSON Structure definition published by Activepieces, describing 5 properties, of which 5 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

name pieceName projectId type value

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-upsert-connection-request-structure.json",
  "name": "UpsertConnectionRequest",
  "description": "Request body for creating or updating a connection",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Connection name",
      "example": "My GitHub Connection"
    },
    "pieceName": {
      "type": "string",
      "description": "Piece package name",
      "example": "@activepieces/piece-github"
    },
    "projectId": {
      "type": "string",
      "description": "Project ID"
    },
    "type": {
      "type": "string",
      "enum": [
        "OAUTH2",
        "API_KEY",
        "BASIC_AUTH",
        "CUSTOM_AUTH"
      ]
    },
    "value": {
      "type": "object",
      "description": "Authentication credentials"
    }
  },
  "required": [
    "name",
    "pieceName",
    "projectId",
    "type",
    "value"
  ]
}