Package version:

Interface WebHookActivity

WebHook activity.

interface WebHookActivity {
    authentication?: WebActivityAuthentication;
    body?: any;
    dependsOn?: ActivityDependency[];
    description?: string;
    headers?: {
        [propertyName: string]: any;
    };
    method: string;
    name: string;
    onInactiveMarkAs?: string;
    policy?: SecureInputOutputPolicy;
    reportStatusOnCallBack?: any;
    state?: string;
    timeout?: string;
    type: "WebHook";
    url: any;
    userProperties?: UserProperty[];
}

Hierarchy (view full)

Properties

authentication? body? dependsOn? description? headers? method name onInactiveMarkAs? policy? reportStatusOnCallBack? state? timeout? type url userProperties?

Properties

Optionalauthentication

authentication?: WebActivityAuthentication

Authentication method used for calling the endpoint.

Optionalbody

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).

OptionaldependsOn

dependsOn?: ActivityDependency[]

Activity depends on condition.

Optionaldescription

description?: string

Activity description.

Optionalheaders

headers?: {
    [propertyName: string]: 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

method: string

Rest API method for target endpoint.

name

name: string

Activity name.

OptionalonInactiveMarkAs

onInactiveMarkAs?: string

Status result of the activity when the state is set to Inactive. This is an optional property and if not provided when the activity is inactive, the status will be Succeeded by default.

Optionalpolicy

policy?: SecureInputOutputPolicy

Activity policy.

OptionalreportStatusOnCallBack

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).

Optionalstate

state?: string

Activity state. This is an optional property and if not provided, the state will be Active by default.

Optionaltimeout

timeout?: 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

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).

OptionaluserProperties

userProperties?: UserProperty[]

Activity user properties.

Settings

Member Visibility