Patch Webhook Configuration

Patch Webhook Configuration

Updates the webhook configuration using patch operation

Request
URI
PATCH
https://{api_host}//vrlic/api/v1/notification/webhook-configurations/{id}
COPY
Path Parameters
string
id
Required

id

Request Body
PatchWebhookConfigurationDto of type(s) application/json
Required 
{
    "id": "78e7e0cd-7666-4b78-b123-7d0aac711b33",
    "name": "test_webhook_configuration",
    "type": "WEBHOOK",
    "cspOrgId": "45bd46ae-8bc8-4115-9e72-28c89292c992",
    "createdBy": "[email protected]",
    "createdAt": "2023-04-27 06:02:20.675",
    "lastUpdatedBy": "[email protected]",
    "lastUpdatedAt": "2023-04-27 06:02:20.675",
    "url": "https://hooks.slack.com/services/SmafV7DQ1f3zJz4VpraTdT0q",
    "contentType": "application/json",
    "payload": "{\n    \"attachments\": [\n        {\n            \"author_name\": \"VMware Aria Operations for Logs\",\n            \"title\": \"Alert Triggered : [${severity}] ${name}\",\n            \"title_link\": \"${resultsUrl}\",\n            \"fields\": [\n                {\n                    \"title\": \"At Time\",\n                    \"value\": \"${triggeredAt}\"\n                },\n                {\n                    \"title\": \"Description\",\n                    \"value\": \"${description}\"\n                },\n                {\n                    \"title\": \"Recommendation\",\n                    \"value\": \"${recommendations}\"\n                }\n            ],\n            \"color\": \"#008ab1\"\n        }\n    ]\n}",
    "action": "PUT",
    "webhookType": "ALERT_NOTIFICATION",
    "userName": "test_user",
    "password": "******",
    "customHeaders": {
        "Authorization": "Bearer LQSe7oYM1tjf770o6cQPIQAmaha6Eyu9"
    },
    "endpointType": "SLACK",
    "endpointProperties": {
        "Authorization": "Bearer LQSe7oYM1tjf770o6cQPIQAmaha6Eyu9"
    },
    "force": false
}
string
id
Optional

Unique notification configuration identifier

string
name
Optional

Unique notification configuration name

string
type
Optional

Unique notification configuration name

Possible values are : EMAIL, WEBHOOK,
string
cspOrgId
Optional

Associated org with the notification

string
createdBy
Optional

Email of user who created this notification

string As date-time As date-time
createdAt
Optional

Time at which notification was created

string
lastUpdatedBy
Optional

Email of user who updated this notification

string As date-time As date-time
lastUpdatedAt
Optional

Time at which notification was last updated

string
url
Optional

Destination url of the webhook notification.

string
contentType
Optional

Indicates the original media type of the webhook payload

string
payload
Optional

Represents the payload/template of the webhook configuration

string
action
Optional

Indicates the webhook action i.e. create or update the configuration

Possible values are : POST, PUT,
string
webhookType
Optional

Indicates the webhook notification type.

Possible values are : ALERT_NOTIFICATION, SYSTEM_ALERT_NOTIFICATION,
string
userName
Optional

Email of user who created this notification

string
password
Optional

password

JsonNode
customHeaders
Optional

customHeaders

string
endpointType
Optional

Indicates the webhook notification endpoint.

Possible values are : SLACK, PAGERDUTY_V1_API, PAGERDUTY_V2_API, DATADOG, VICTOROPS, OTHERS,
JsonNode
endpointProperties
Optional

endpointProperties

boolean
force
Optional

It represents other objects in the system have referential dependencies on this webhook. Saving changes to this webhook may cause behavioral changes in other objects.Before saving this change, be sure there are no unintended consequences on the following objects, as the previous state of this webhook can’t be retrieved. If you still want to save changes to this notification then set this parameter ‘force’ as value ’true’ with the request body while calling this Api

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WebhookConfigurationDto of type(s) */* 
{
    "id": "573ef541-e9cb-475a-8f50-793979d1d9a0",
    "name": "test_webhook_configuration",
    "type": "WEBHOOK",
    "cspOrgId": "e552932c-1274-4495-b7f5-a647f3c0ec69",
    "createdBy": "[email protected]",
    "createdAt": "2023-06-23T08:50:39.055532Z",
    "lastUpdatedBy": "[email protected]",
    "lastUpdatedAt": "2023-06-23T08:50:39.055532Z",
    "url": "https://hooks.slack.com/services/SmafV7DQ1f3zJz4VpraTdT0q",
    "contentType": "application/json",
    "action": "POST",
    "webhookType": "ALERT_NOTIFICATION",
    "userName": "test_user",
    "password": "******",
    "customHeaders": {
        "Authorization": "Bearer LQSe7oYM1tjf770o6cQPIQAmaha6Eyu9"
    },
    "endpointType": "SLACK",
    "endpointProperties": {
        "Authorization": "Bearer LQSe7oYM1tjf770o6cQPIQAmaha6Eyu9"
    },
    "force": false
}
string
id
Optional

Unique notification configuration identifier

string
name
Required

Unique notification configuration name

string
type
Required

Unique notification configuration name

Possible values are : EMAIL, WEBHOOK,
string
cspOrgId
Optional

Associated org with the notification

string
createdBy
Optional

Email of user who created this notification

string As date-time As date-time
createdAt
Optional

Time at which notification was created

string
lastUpdatedBy
Optional

Email of user who updated this notification

string As date-time As date-time
lastUpdatedAt
Optional

Time at which notification was last updated

string
url
Required

Destination url of the webhook notification.

string
contentType
Required

Indicates the original media type of the webhook payload

WebhookPayloadTemplate
payload
Required

payload

string
action
Optional

Indicates the webhook action i.e. create or update the configuration

Possible values are : POST, PUT,
string
webhookType
Required

Indicates the webhook notification type.

Possible values are : ALERT_NOTIFICATION, SYSTEM_ALERT_NOTIFICATION,
string
userName
Optional

Email of user who created this notification

string
password
Optional

password

JsonNode
customHeaders
Optional

customHeaders

string
endpointType
Optional

Indicates the webhook notification endpoint.

Possible values are : SLACK, PAGERDUTY_V1_API, PAGERDUTY_V2_API, DATADOG, VICTOROPS, OTHERS,
JsonNode
endpointProperties
Optional

endpointProperties

boolean
force
Optional

It represents other objects in the system have referential dependencies on this webhook. Saving changes to this webhook may cause behavioral changes in other objects.Before saving this change, be sure there are no unintended consequences on the following objects, as the previous state of this webhook can’t be retrieved. If you still want to save changes to this notification then set this parameter ‘force’ as value ’true’ with the request body while calling this Api


On This Page
Webhook Notifications Operations
POST
Create Webhook Configuration
DELETE
Delete Webhook Configuration
GET
Get Webhook Configuration
GET
Get Webhook Configurations
PATCH
Patch Webhook Configuration
PUT
Update Webhook Configuration