Piece Schema

actions

object

required

Show child attributes

actions.{key}

object

Show child attributes

actions.{key}.description

string

required

actions.{key}.displayName

string

required

actions.{key}.name

string

required

actions.{key}.props

object

required

Show child attributes

actions.{key}.props.{key}

object

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
• Option 13
• Option 14
• Option 15
• Option 16
• Option 17
• Option 18
• Option 19

Show child attributes

actions.{key}.props.{key}.displayName

string

required

actions.{key}.props.{key}.required

boolean

required

actions.{key}.props.{key}.type

enum<string>

required

Available options:

SHORT_TEXT

actions.{key}.props.{key}.defaultValue

any

actions.{key}.props.{key}.description

string

actions.{key}.requireAuth

boolean

required

actions.{key}.errorHandlingOptions

object

Show child attributes

actions.{key}.errorHandlingOptions.continueOnFailure

object

required

Show child attributes

actions.{key}.errorHandlingOptions.continueOnFailure.defaultValue

boolean

actions.{key}.errorHandlingOptions.continueOnFailure.hide

boolean

actions.{key}.errorHandlingOptions.retryOnFailure

object

required

Show child attributes

actions.{key}.errorHandlingOptions.retryOnFailure.defaultValue

boolean

actions.{key}.errorHandlingOptions.retryOnFailure.hide

boolean

authors

string[]

required

description

string

required

displayName

string

required

logoUrl

string

required

name

string

required

triggers

object

required

Show child attributes

triggers.{key}

object

Show child attributes

triggers.{key}.description

string

required

triggers.{key}.displayName

string

required

triggers.{key}.name

string

required

triggers.{key}.props

object

required

Show child attributes

triggers.{key}.props.{key}

object

• Option 1
• Option 2
• Option 3
• Option 4
• Option 5
• Option 6
• Option 7
• Option 8
• Option 9
• Option 10
• Option 11
• Option 12
• Option 13
• Option 14
• Option 15
• Option 16
• Option 17
• Option 18
• Option 19

Show child attributes

triggers.{key}.props.{key}.displayName

string

required

triggers.{key}.props.{key}.required

boolean

required

triggers.{key}.props.{key}.type

enum<string>

required

Available options:

SHORT_TEXT

triggers.{key}.props.{key}.defaultValue

any

triggers.{key}.props.{key}.description

string

triggers.{key}.sampleData

any

required

triggers.{key}.testStrategy

required

Available options:

SIMULATION

triggers.{key}.type

required

Available options:

POLLING

triggers.{key}.errorHandlingOptions

object

Show child attributes

triggers.{key}.errorHandlingOptions.continueOnFailure

object

required

Show child attributes

triggers.{key}.errorHandlingOptions.continueOnFailure.defaultValue

boolean

triggers.{key}.errorHandlingOptions.continueOnFailure.hide

boolean

triggers.{key}.errorHandlingOptions.retryOnFailure

object

required

Show child attributes

triggers.{key}.errorHandlingOptions.retryOnFailure.defaultValue

boolean

triggers.{key}.errorHandlingOptions.retryOnFailure.hide

boolean

triggers.{key}.handshakeConfiguration

object

Show child attributes

triggers.{key}.handshakeConfiguration.strategy

required

Available options:

NONE

triggers.{key}.handshakeConfiguration.paramName

string

triggers.{key}.renewConfiguration

object

• Option 1
• Option 2

Show child attributes

triggers.{key}.renewConfiguration.cronExpression

string

required

triggers.{key}.renewConfiguration.strategy

enum<string>

required

Available options:

CRON

version

string

required

auth

object

• Option 1
• Option 2
• Option 3
• Option 4

Show child attributes

auth.displayName

string

required

auth.password

object

required

Show child attributes

auth.password.displayName

string

required

auth.password.description

string

auth.required

boolean

required

auth.type

enum<string>

required

Available options:

BASIC_AUTH

auth.username

object

required

Show child attributes

auth.username.displayName

string

required

auth.username.description

string

auth.defaultValue

any

auth.description

string

categories

enum<string>[]

Available options:

ARTIFICIAL_INTELLIGENCE

directoryPath

string

id

string

maximumSupportedRelease

string

minimumSupportedRelease

string

platformId

string

projectId

string