WebHookActivityArgs

data class WebHookActivityArgs(val authentication: Output<WebActivityAuthenticationArgs>? = null, val body: Output<Any>? = null, val dependsOn: Output<List<ActivityDependencyArgs>>? = null, val description: Output<String>? = null, val headers: Output<Any>? = null, val method: Output<Either<String, WebHookActivityMethod>>, val name: Output<String>, val reportStatusOnCallBack: Output<Any>? = null, val timeout: Output<String>? = null, val type: Output<String>, val url: Output<Any>, val userProperties: Output<List<UserPropertyArgs>>? = null) : ConvertibleToJava<WebHookActivityArgs>

WebHook activity.

Constructors

Link copied to clipboard
constructor(authentication: Output<WebActivityAuthenticationArgs>? = null, body: Output<Any>? = null, dependsOn: Output<List<ActivityDependencyArgs>>? = null, description: Output<String>? = null, headers: Output<Any>? = null, method: Output<Either<String, WebHookActivityMethod>>, name: Output<String>, reportStatusOnCallBack: Output<Any>? = null, timeout: Output<String>? = null, type: Output<String>, url: Output<Any>, userProperties: Output<List<UserPropertyArgs>>? = null)

Properties

Link copied to clipboard

Authentication method used for calling the endpoint.

Link copied to clipboard
val body: Output<Any>? = null

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

Link copied to clipboard
val dependsOn: Output<List<ActivityDependencyArgs>>? = null

Activity depends on condition.

Link copied to clipboard
val description: Output<String>? = null

Activity description.

Link copied to clipboard
val headers: Output<Any>? = null

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

Link copied to clipboard
val method: Output<Either<String, WebHookActivityMethod>>

Rest API method for target endpoint.

Link copied to clipboard
val name: Output<String>

Activity name.

Link copied to clipboard
val reportStatusOnCallBack: Output<Any>? = null

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

Link copied to clipboard
val timeout: Output<String>? = null

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-9)):(60|(0-9)).

Link copied to clipboard
val type: Output<String>

Type of activity. Expected value is 'WebHook'.

Link copied to clipboard
val url: Output<Any>

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

Link copied to clipboard
val userProperties: Output<List<UserPropertyArgs>>? = null

Activity user properties.

Functions

Link copied to clipboard
open override fun toJava(): WebHookActivityArgs