Share via

WebHookActivity interface

  • Reference
Package:
@azure/arm-datafactory

WebHook activity.

Extends
ControlActivity

Properties

authentication

Authentication method used for calling the endpoint.
body

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

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

Activity policy.
reportStatusOnCallBack

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

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

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

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

Inherited Properties

dependsOn

Activity depends on condition.
description

Activity description.
name

Activity name.
onInactiveMarkAs

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

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

Activity user properties.

Property Details

authentication

Authentication method used for calling the endpoint.

authentication?: WebActivityAuthentication

Property Value

WebActivityAuthentication

body

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

body?: any

Property Value

any

headers

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

headers?: {[propertyName: string]: any}

Property Value

{[propertyName: string]: any}

method

Rest API method for target endpoint.

method: string

Property Value

string

policy

Activity policy.

policy?: SecureInputOutputPolicy

Property Value

SecureInputOutputPolicy

reportStatusOnCallBack

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

reportStatusOnCallBack?: any

Property Value

any

timeout

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

timeout?: string

Property Value

string

type

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

type: "WebHook"

Property Value

"WebHook"

url

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

url: any

Property Value

any

Inherited Property Details

dependsOn

Activity depends on condition.

dependsOn?: ActivityDependency[]

Property Value

ActivityDependency[]

Inherited From ControlActivity.dependsOn

description

Activity description.

description?: string

Property Value

string

Inherited From ControlActivity.description

name

Activity name.

name: string

Property Value

string

Inherited From ControlActivity.name

onInactiveMarkAs

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.

onInactiveMarkAs?: string

Property Value

string

Inherited From ControlActivity.onInactiveMarkAs

state

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

state?: string

Property Value

string

Inherited From ControlActivity.state

userProperties

Activity user properties.

userProperties?: UserProperty[]

Property Value

UserProperty[]

Inherited From ControlActivity.userProperties