Piece Schema

{
  "id": "<string>",
  "name": "<string>",
  "displayName": "<string>",
  "logoUrl": "<string>",
  "description": "<string>",
  "projectId": "<string>",
  "platformId": "<string>",
  "directoryPath": "<string>",
  "auth": {
    "displayName": "<string>",
    "description": "<string>",
    "username": {
      "displayName": "<string>",
      "description": "<string>"
    },
    "password": {
      "displayName": "<string>",
      "description": "<string>"
    },
    "type": "BASIC_AUTH",
    "required": true,
    "defaultValue": "<any>"
  },
  "version": "<string>",
  "minimumSupportedRelease": "<string>",
  "maximumSupportedRelease": "<string>",
  "actions": {},
  "triggers": {}
}

name

string

required

displayName

string

required

logoUrl

string

required

description

string

required

version

string

required

actions

object

required

Show child attributes

triggers

object

required

Show child attributes

string

projectId

string

platformId

string

directoryPath

string

auth

object

Show child attributes

minimumSupportedRelease

string

maximumSupportedRelease

string

Delete Flow Install Piece

Get Started

Endpoints