WebHookActivity Class

  • Reference

Definition

Namespace:
Azure.Analytics.Synapse.Artifacts.Models
Assembly:
Azure.Analytics.Synapse.Artifacts.dll
Package:
Azure.Analytics.Synapse.Artifacts v1.0.0-preview.20
Source:
WebHookActivity.cs

WebHook activity.

[System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.WebHookActivity+WebHookActivityConverter))]
public class WebHookActivity : Azure.Analytics.Synapse.Artifacts.Models.ControlActivity
[<System.Text.Json.Serialization.JsonConverter(typeof(Azure.Analytics.Synapse.Artifacts.Models.WebHookActivity+WebHookActivityConverter))>]
type WebHookActivity = class
    inherit ControlActivity
Public Class WebHookActivity
Inherits ControlActivity
Inheritance
Object
Activity
ControlActivity
WebHookActivity
Attributes
JsonConverterAttribute

Constructors

WebHookActivity(String, WebHookActivityMethod, Object)

Initializes a new instance of WebHookActivity.

Properties

AdditionalProperties

Additional Properties.

(Inherited from Activity)
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).
DependsOn

Activity depends on condition.

(Inherited from Activity)
Description

Activity description.

(Inherited from Activity)
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.
Name

Activity name.

(Inherited from Activity)
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.

(Inherited from Activity)
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).
State

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

(Inherited from Activity)
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])).
Url

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

Activity user properties.

(Inherited from Activity)

Applies to