webhook.JsonWebhook
Description unavailable
Type hierarchy: webhook.JsonWebhook > webhook.WebHook > xlrelease.PythonScript > xlrelease.BasePythonScript > udm.BaseConfigurationItem
Label: Webhook: Json Webhook
Properties
| Property | Kind | Description |
|---|---|---|
| customScriptTask | xlrelease.CustomScriptTask (parent) | Custom Script Task |
| URL | String | HTTP address to invoke |
| method | String | HTTP method to use : GET, PUT, POST, DELETE, PATCH |
| body | String | HTTP request body |
| username | String | HTTP Basic authentication username |
| password | Password | HTTP Basic authentication password |
| proxyHost | String | HTTP proxy host |
| proxyPort | String | HTTP proxy port |
| proxyUsername | String | HTTP proxy username |
| proxyPassword | Password | HTTP proxy password |
| result | String | Result of the first expression |
| result2 | String | Result of the second expression |
| result3 | String | Result of the third expression |
| jsonPathExpression | String | JSON Path expression to select the first value |
| jsonPathExpression2 | String | JSON Path expression to select the second value |
| jsonPathExpression3 | String | JSON Path expression to select the third value |
customScriptTask
Custom Script Task
- Label: Custom Script Task
- Kind: xlrelease.CustomScriptTask (parent)
- Required: false
- Reference type: xlrelease.CustomScriptTask
- As containment: true
URL
HTTP address to invoke
- Label: URL
- Kind: String
- Required: true
- Category: input
method
HTTP method to use : GET, PUT, POST, DELETE, PATCH
- Label: HTTP method
- Kind: String
- Default value: GET
- Required: true
- Category: input
body
HTTP request body
- Label: HTTP body
- Kind: String
- Size: LARGE
- Required: false
- Category: input
username
HTTP Basic authentication username
- Label: Username
- Kind: String
- Required: false
- Category: input
password
HTTP Basic authentication password
- Label: Password
- Kind: Password
- Password: true
- Required: false
- Category: input
proxyHost
HTTP proxy host
- Label: Proxy Host
- Kind: String
- Required: false
- Category: input
proxyPort
HTTP proxy port
- Label: Proxy Port
- Kind: String
- Required: false
- Category: input
proxyUsername
HTTP proxy username
- Label: Proxy Username
- Kind: String
- Required: false
- Category: input
proxyPassword
HTTP proxy password
- Label: Proxy Password
- Kind: Password
- Password: true
- Required: false
- Category: input
result
Result of the first expression
- Label: Result 1
- Kind: String
- Required: false
- Category: output
result2
Result of the second expression
- Label: Result 2
- Kind: String
- Required: false
- Category: output
result3
Result of the third expression
- Label: Result 3
- Kind: String
- Required: false
- Category: output
jsonPathExpression
JSON Path expression to select the first value
- Label: JSON Path Expression 1
- Kind: String
- Required: false
- Category: input
jsonPathExpression2
JSON Path expression to select the second value
- Label: JSON Path Expression 2
- Kind: String
- Required: false
- Category: input
jsonPathExpression3
JSON Path expression to select the third value
- Label: JSON Path Expression 3
- Kind: String
- Required: false
- Category: input
Hidden properties
| Property | Kind | Description |
|---|---|---|
| configurationUri | String | URI of the HTML file to render the task for custom script tasks |
| maxOutputPropertySize | Integer | Maximum size of output property values of type string. Default value is 32768 |
| iconLocation | String | Icon Location |
| iconClass | String | Icon Class |
| taskColor | String | Task Color |
| preconditionEnabled | Boolean | Indicates whether preconditions should be enabled |
| failureHandlerEnabled | Boolean | Indicates whether failure handler should be enabled |
| scriptLocation | String | Script Location |
| outputVarHelpText | String | Output Var Help Text |
configurationUri
URI of the HTML file to render the task for custom script tasks
- Key:
webhook.JsonWebhook.configurationUri - Kind: String
- Default value:
- Hidden: true
maxOutputPropertySize
Maximum size of output property values of type string. Default value is 32768
- Key:
webhook.JsonWebhook.maxOutputPropertySize - Kind: Integer
- Default value: 32768
- Hidden: true
iconLocation
Icon Location
- Key:
webhook.JsonWebhook.iconLocation - Kind: String
- Default value:
- Hidden: true
iconClass
Icon Class
- Key:
webhook.JsonWebhook.iconClass - Kind: String
- Default value:
- Hidden: true
taskColor
Task Color
- Key:
webhook.JsonWebhook.taskColor - Kind: String
- Default value: #009CDB
- Hidden: true
preconditionEnabled
Indicates whether preconditions should be enabled
- Key:
webhook.JsonWebhook.preconditionEnabled - Kind: Boolean
- Default value: true
- Hidden: true
failureHandlerEnabled
Indicates whether failure handler should be enabled
- Key:
webhook.JsonWebhook.failureHandlerEnabled - Kind: Boolean
- Default value: true
- Hidden: true
scriptLocation
Script Location
- Key:
webhook.JsonWebhook.scriptLocation - Kind: String
- Default value: webhook/Webhook.py
- Hidden: true
outputVarHelpText
Output Var Help Text
- Key:
webhook.JsonWebhook.outputVarHelpText - Kind: String
- Default value: Specify the release variable in which to store the result of the JSON query (optional)
- Hidden: true