Adf Webhook Activity Element
X-Ref:
- Ast Adf Webhook Activity Node
- Ast Adf Activity Base Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| Method | AdfWebhookActivityMethod | Post | Specifies the method for the Webhook Activity. Currently only 'Post' is supported. This is a required property |
| Name | String | 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 | |
| Url | String | 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 | |
| ReportStatusOnCallback | Boolean | False | Specifies whether to report the status code on callback. |
| Timeout | String | "10" | Specifies the timeout length for the webhook activity connection. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <Authentication /> | AstAdfWebActivityAuthenticationNode | AstAdfWebActivityAuthenticationNode objects specify the authentication type and the credentials to be passed to the target end point. |
| <Body /> | AstAdfWebActivityBodyNode | This represents the paylod to send to the endpoint in Post/Put Web Activities. The node contains a collection of Linked Services, a collection of Datasets, and a collection of Key/Value parameters. |
| <Description /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
| <Scheduler /> | AstAdfActivityScheduleNode | AstAdfActivityScheduleNode objects correspond directly to scheduler specifications for activities in Azure Data Factory. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <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. |