PUT Notification Webhook Webhook Id

Update specified webhook configuration.

Request

URI

PUT

https://{api_host}/api/v2/notification/webhook/{webhookId}

COPY

Path Parameters

string

webhookId

Required

The UUID of the webhook

Request Body

{
    "proxyId": "760b1a86-e590-4890-939b-c504c491a072",
    "URLs": [
        "https://hooks.test.com/services/T024JFTN4/B01SGHM16H5/kQjkrkIjgurn9buzOaizuj6O"
    ],
    "destinationApp": "custom",
    "contentType": "JSON",
    "payload": "{\n  \"alert_type\": \"${AlertType}\",\n  \"alert_name\": \"${AlertName}\",\n  \"search_period\": \"${SearchPeriod}\",\n  \"hit_oeprator\": \"${HitOperator}\",\n  \"messages\": \"${messagesString}\"\n}",
    "headers": "{\"Action\":\"POST\",\"contentType\":\"application/json\"}",
    "name": "test",
    "acceptCert": false,
    "sendIndividualLogs": false
}

string

proxyId

Optional

Web proxy configuration ID.

array of string

URLs

Optional

Webhook configuration URLs.

string

destinationApp

Optional

Webhook configuration destination. Possible values are - pagerduty, slack, vro, custom.

string

contentType

Optional

Webhook configuration content type for sending data to webhook destination. Possible values are - json, xml.

string

payload

Optional

Webhook configuration payload for sending data to webhook destination.

string

name

Optional

Webhook configuration name.

string

headers

Optional

Webhook configuration headers for sending data to webhook destination.

boolean

acceptCert

Optional

Webhook configuration destination certificate trust policy.

boolean

sendIndividualLogs

Optional

Webhook configuration for sending individual or combined notification for logs.

Authentication

This operation uses the following authentication methods.

Bearer

Responses

200

Successfully updated webhook information.

{
    "id": "760b1a86-e590-4890-939b-c504c491a072",
    "proxyId": "760b1a86-e590-4890-939b-c504c491a072",
    "URLs": [
        "https://hooks.test.com/services/T024JFTN4/B01SGHM16H5/kQjkrkIjgurn9buzOaizuj6O"
    ],
    "destinationApp": "custom",
    "contentType": "JSON",
    "payload": "{\n  \"alert_type\": \"${AlertType}\",\n  \"alert_name\": \"${AlertName}\",\n  \"search_period\": \"${SearchPeriod}\",\n  \"hit_oeprator\": \"${HitOperator}\",\n  \"messages\": \"${messagesString}\"\n}",
    "name": "test-hasmik",
    "headers": "{\"Action\":\"POST\",\"contentType\":\"application/json\"}",
    "acceptCert": false,
    "sendIndividualLogs": false
}

string

Optional

Webhook configuration ID.

string

proxyId

Optional

Web proxy configuration ID.

array of string

URLs

Optional

Webhook configuration URLs.

string

destinationApp

Optional

Webhook configuration destination. Possible values are - pagerduty, slack, vro, custom.

string

contentType

Optional

Webhook configuration content type for sending data to webhook destination. Possible values are - json, xml.

string

payload

Optional

Webhook configuration payload for sending data to webhook destination.

string

name

Optional

Webhook configuration name.

string

headers

Optional

Webhook configuration headers for sending data to webhook destination.

boolean

acceptCert

Optional

Webhook configuration destination certificate trust policy.

boolean

sendIndividualLogs

Optional

Webhook configuration for sending individual or combined notification for logs.

400

The request failed because the request body either did not contain valid JSON, or did not match the required JSON format.

Returns error of type(s) application/json

{
    "errorMessage": "Invalid request body.",
    "errorCode": "JSON_FORMAT_ERROR",
    "errorDetails": {
        "reason": "..."
    }
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,

object

errorDetails

Optional

Dynamic error details, where the field name can vary depending on the request field and error code.

401

Operation doesn't return any data structure

440

Operation doesn't return any data structure

495

SSL connection failed.

Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json

{
    "errorMessage": "The operation failed due to an internal error."
}

string

errorMessage

Required

A message describing the error.

string

errorCode

Optional

A code representing the type of error.

object

errorDetails

Optional

Dynamic error details, where the field name can vary depending on the request field and error code.

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/api/v2/notification/webhook/{webhookId}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Notification Operations

GET

GET Notification Channels