WebHookActivityResponse

data class WebHookActivityResponse(val authentication: WebActivityAuthenticationResponse? = null, val body: Any? = null, val dependsOn: List<ActivityDependencyResponse>? = null, val description: String? = null, val headers: Map<String, Any>? = null, val method: String, val name: String, val onInactiveMarkAs: String? = null, val policy: SecureInputOutputPolicyResponse? = null, val reportStatusOnCallBack: Any? = null, val state: String? = null, val timeout: String? = null, val type: String, val url: Any, val userProperties: List<UserPropertyResponse>? = null)

WebHook activity.

Constructors

Link copied to clipboard
constructor(authentication: WebActivityAuthenticationResponse? = null, body: Any? = null, dependsOn: List<ActivityDependencyResponse>? = null, description: String? = null, headers: Map<String, Any>? = null, method: String, name: String, onInactiveMarkAs: String? = null, policy: SecureInputOutputPolicyResponse? = null, reportStatusOnCallBack: Any? = null, state: String? = null, timeout: String? = null, type: String, url: Any, userProperties: List<UserPropertyResponse>? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Authentication method used for calling the endpoint.

Link copied to clipboard
val body: 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

Activity depends on condition.

Link copied to clipboard
val description: String? = null

Activity description.

Link copied to clipboard
val headers: Map<String, 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

Rest API method for target endpoint.

Link copied to clipboard

Activity name.

Link copied to clipboard

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.

Link copied to clipboard

Activity policy.

Link copied to clipboard

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 state: String? = null

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

Link copied to clipboard
val timeout: 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

Type of activity. Expected value is 'WebHook'.

Link copied to clipboard
val url: Any

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

Link copied to clipboard

Activity user properties.