Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebHookActivity

Package version

WebHook activity.

Hierarchy

Indexable

[property: string]: any

Describes unknown properties. The value of an unknown property can be of "any" type.

Index

Properties

Optional authentication

Authentication method used for calling the endpoint.

Optional body

body: any

Represents the payload that will be sent to the endpoint. Required for POST/PUT method, not allowed for GET method Type: string (or Expression with resultType string).

Optional dependsOn

dependsOn: ActivityDependency[]

Activity depends on condition.

Optional description

description: undefined | string

Activity description.

Optional headers

headers: any

Represents the headers that will be sent to the request. For example, to set the language and type on a request: "headers" : { "Accept-Language": "en-us", "Content-Type": "application/json" }. Type: string (or Expression with resultType string).

method

Rest API method for target endpoint.

name

name: string

Activity name.

Optional reportStatusOnCallBack

reportStatusOnCallBack: any

When set to true, statusCode, output and error in callback request body will be consumed by activity. The activity can be marked as failed by setting statusCode >= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

Optional timeout

timeout: undefined | string

The timeout within which the webhook should be called back. If there is no value specified, it defaults to 10 minutes. Type: string. Pattern: ((\d+).)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).

type

type: "WebHook"

Polymorphic discriminator, which specifies the different types this object can be

url

url: any

WebHook activity target endpoint and path. Type: string (or Expression with resultType string).

Optional userProperties

userProperties: UserProperty[]

Activity user properties.

Generated using TypeDoc