Skip to main content

Adf Webhook Activity Element

Adf Webhook Activity Element​

API Type:

Varigence.Languages.Biml.DataFactory.AstAdfWebhookActivityNode

X-Ref:

Attributes

AttributeAPI TypeDefaultDescription
MethodAdfWebhookActivityMethodPost
Specifies the method for the Webhook Activity. Currently only 'Post' is supported. This is a required property
NameString 
Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property
UrlString 
If the Url is a string value, then it specifies the target endpoint, if it is an expression then it evaluates to the target endpoint. This is a required property
OnInactiveMarkAsAdfActivityOnInactiveMarkAsSucceeded
Specifies the status result of the activity when the state is set to Inactive (Succeeded, Failed, or Skipped). If not provided when the activity is inactive, the status will be Succeeded by default.
ReportStatusOnCallbackBooleanFalse
Specifies whether to report the status code on callback.
SecureInputBooleanFalse
When set to true, input from the activity is considered as secure and will not be logged to monitoring.
SecureOutputBooleanFalse
When set to true, output from the activity is considered as secure and will not be logged to monitoring.
StateAdfActivityStateActive
Specifies the state of the activity (Active or Inactive). If not provided, the state will be Active by default.
TimeoutString"10"
Specifies the timeout length for the webhook activity connection.

Singleton Children​

ChildAPI TypeDescription
<Authentication />AstAdfWebActivityAuthenticationNodeAstAdfWebActivityAuthenticationNode objects specify the authentication type and the credentials to be passed to the target end point.
<Body />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<Description />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<RawJsonProperties />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<RawJsonTypeProperties />StringString is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx.
<Scheduler />AstAdfActivityScheduleNodeAstAdfActivityScheduleNode objects correspond directly to scheduler specifications for activities in Azure Data Factory.

Collection Children​

ChildAPI TypeDescription
<Annotations>
    <Annotation />
</Annotations>
AstAnnotationNode
This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code.
<Dependencies>
    <Dependency />
</Dependencies>
AstAdfActivityDependencyNode
This is the collection of activity dependencies that will control the execution of this Azure Data Factory activity.
<Headers>
    <Header />
</Headers>
AstAdfWebActivityKeyValueNode
Specifies a list of headers that are sent to the request end point. "Content-Type" is a required key.
<PipelineParameters>
    <Parameter />
</PipelineParameters>
AstAdfPipelineParameterNode
This is the collection of parameters that will be available to expressions in this Azure Data Factory activity. These parameters will be promoted automatically to the parent pipeline.
<UserProperties>
    <UserProperty />
</UserProperties>
AstAdfActivityUserPropertyNode
This is the collection of user properties that the user can monitor in the Adf monitor window.