Share via


WebHookActivity Class

Definition

WebHook activity.

[Microsoft.Rest.Serialization.JsonTransformation]
[Newtonsoft.Json.JsonObject("WebHook")]
public class WebHookActivity : Microsoft.Azure.Management.DataFactory.Models.ControlActivity
[<Microsoft.Rest.Serialization.JsonTransformation>]
[<Newtonsoft.Json.JsonObject("WebHook")>]
type WebHookActivity = class
    inherit ControlActivity
Public Class WebHookActivity
Inherits ControlActivity
Inheritance
WebHookActivity
Attributes
JsonTransformationAttribute Newtonsoft.Json.JsonObjectAttribute

Constructors

WebHookActivity()

Initializes a new instance of the WebHookActivity class.

WebHookActivity(String, Object, IDictionary<String,Object>, String, IList<ActivityDependency>, IList<UserProperty>, String, Object, Object, WebActivityAuthentication, Object)

Initializes a new instance of the WebHookActivity class.

Properties

AdditionalProperties

Gets or sets unmatched properties from the message are deserialized this collection

(Inherited from Activity)
Authentication

Gets or sets authentication method used for calling the endpoint.

Body

Gets or sets 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).

DependsOn

Gets or sets activity depends on condition.

(Inherited from Activity)
Description

Gets or sets activity description.

(Inherited from Activity)
Headers

Gets or sets 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

Gets or sets activity name.

(Inherited from Activity)
ReportStatusOnCallBack

Gets or sets 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 &gt;= 400 in callback request. Default is false. Type: boolean (or Expression with resultType boolean).

Timeout

Gets or sets 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])).

Url

Gets or sets webHook activity target endpoint and path. Type: string (or Expression with resultType string).

UserProperties

Gets or sets activity user properties.

(Inherited from Activity)

Methods

Validate()

Validate the object.

Applies to