webhook params Schema #

undefined#/properties/postProcess/items/allOf/27/properties/params

Parameters to be passed to the webhook module

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Allowed	none	specSchema.schema.json*

params Type #

object (webhook params)

webhook params Properties #

Property	Type	Required	Nullable	Defined by
itemPreparer	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
inputConverter	Flexible	Required	cannot be null	specSchema (Unified Pipeline Specification)
outputConverter	Flexible	Required	cannot be null	specSchema (Unified Pipeline Specification)
validateStatus	Flexible	Optional	cannot be null	specSchema (Unified Pipeline Specification)
onError	Not specified	Optional	cannot be null	specSchema (Unified Pipeline Specification)
awsSigV4	`boolean`	Optional	cannot be null	specSchema (Unified Pipeline Specification)
awsSigV4Region	`string`	Optional	cannot be null	specSchema (Unified Pipeline Specification)
awsSigV4Service	`string`	Optional	cannot be null	specSchema (Unified Pipeline Specification)
awsAccess	`object`	Optional	cannot be null	specSchema (Unified Pipeline Specification)
data	Not specified	Optional	cannot be null	specSchema (Unified Pipeline Specification)

itemPreparer #

itemPreparer TODO

itemPreparer

is optional
type: any of the folllowing: array or string (itemPreparer)
cannot be null
defined in: itemPreparer

inputConverter #

inputConverter TODO

inputConverter

is required
type: any of the folllowing: array or string (inputConverter)
cannot be null
defined in: inputConverter

outputConverter #

outputConverter TODO

outputConverter

is required
type: any of the folllowing: array or string (outputConverter)
cannot be null
defined in: outputConverter

validateStatus #

validateStatus TODO

validateStatus

is optional
type: any of the folllowing: array or string (validateStatus)
cannot be null
defined in: validateStatus

onError #

Enumeration of strings with constraints below

onError

is optional
type: unknown (onError)
cannot be null
defined in: onError

onError Constraints #

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"throw"`
`"ignore"`

awsSigV4 #

awsSigV4 TODO

awsSigV4

is optional
type: boolean
cannot be null
Unstructured type

awsSigV4Region #

awsSigV4Region TODO

awsSigV4Region

is optional
type: string
cannot be null
Unstructured type

awsSigV4Service #

awsSigV4Service TODO

awsSigV4Service

is optional
type: string
cannot be null
Unstructured type

awsAccess #

AWS Access Credentials

awsAccess

is optional
type: object (awsAccess)
cannot be null
defined in: awsAccess

data #

Inline data to be processed by the JSONata expressions

data

is optional
type: unknown (data)
cannot be null
defined in: data