[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs

Create Webhook Payload Parameter

Description

You can configure a webhook to send alert notifications to a remote web server. Webhooks provide notifications over HTTP POST

Request

Request

URL

URL


post
https://{api_host}/vrlic/api/v1/alert/webhook-payload-parameters
Copy

Request Body

Request Body

WebhookPayloadParameterState of mimetype application/json Required
{
	"payloadParameters": {
		"key": {
			"description": "string",
			"exampleString": "string",
			"isRequired": false
		}
	},
	"template": "ALERT"
}
payloadParameters Optional

Parameters available for a template


string
template Optional

Template for notification types, which includes: ALERT, SYSTEM_ALERT

Possible values are: ALERTSYSTEM_ALERT

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns WebhookPayloadParameterState of type */*

Response body may vary based on the type of template you select. for ALERT template, possible keys are description, name, resultsUrl, severity, sourceInfo, triggeredAt, additionalInfo, additionalInfoJson, alertType, hitCount, hitOperator, recommendations, searchPeriod. and for SYSTEM_ALERT template, possible keys are details, eventType, incidentKey, name, sourceInfo, status, triggeredAt, triggeredAtMillis

{
	"payloadParameters": {
		"key": {
			"description": "string",
			"exampleString": "string",
			"isRequired": false
		}
	},
	"template": "ALERT"
}
payloadParameters Optional

Parameters available for a template


string
template Optional

Template for notification types, which includes: ALERT, SYSTEM_ALERT

Possible values are: ALERTSYSTEM_ALERT

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"payloadParameters":{"key":{"description":"string","exampleString":"string","isRequired":false}},"template":"ALERT"}' https://{api_host}/vrlic/api/v1/alert/webhook-payload-parameters


[{"label":"Latest (v1)","version":"latest"}]
vmware-aria-operations-for-logs
Feedback

Was this page helpful?