Update Webhook

Update Webhook

Updates a webhook subscriber in the specified organization using the data included in the request.

Request
URI
PATCH
https://stg.skyscraper.vmware.com/api/notification/{orgId}/webhooks/{webhook}
COPY
Path Parameters
string
orgId
Required

Org ID

string
webhook
Required

Webhook identifier

Request Body
Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WebhookResponse of type(s) application/json 
{
    "created": "string",
    "updated": "string",
    "version": 0,
    "id": "string",
    "web_hook_info": {
        "callback_uri": "string",
        "callback_headers": {
            "callback_headers": "string"
        },
        "subscribed_categories": [
            "string"
        ],
        "subscribed_notification_types": [
            "string"
        ],
        "unsubscribed_notification_types": [
            "string"
        ]
    },
    "status": "string",
    "name": "string",
    "providers": [
        "string"
    ],
    "contact": "[email protected]/#vmc-notification-gw",
    "org_id": "string",
    "created_by": "[email protected]",
    "updated_by": "[email protected]"
}
string As date-time As date-time
created
Optional

The creation date of entity.

string As date-time As date-time
updated
Optional

The update date of entity.

integer As int32 As int32
version
Optional

Version of this entity.

string As uuid As uuid
id
Optional

Unique ID for this entity.

object
web_hook_info
Required

web_hook_info

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string
name
Optional

name

array of string
providers
Required
Constraints: minItems: 1 maxItems: 2147483647

providers

string
contact
Optional

Team member email or slack channel to be contacted if needed

string As uuid As uuid
org_id
Optional

org_id

string
created_by
Optional

The username of the person/app who created the notification type

string
updated_by
Optional

The username of the person/app who updated the notification type


400

Bad Request

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


401

Unauthorized

Returns WebhookResponse of type(s) application/json 
"WebhookResponse Object"
string As date-time As date-time
created
Optional

The creation date of entity.

string As date-time As date-time
updated
Optional

The update date of entity.

integer As int32 As int32
version
Optional

Version of this entity.

string As uuid As uuid
id
Optional

Unique ID for this entity.

object
web_hook_info
Required

web_hook_info

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string
name
Optional

name

array of string
providers
Required
Constraints: minItems: 1 maxItems: 2147483647

providers

string
contact
Optional

Team member email or slack channel to be contacted if needed

string As uuid As uuid
org_id
Optional

org_id

string
created_by
Optional

The username of the person/app who created the notification type

string
updated_by
Optional

The username of the person/app who updated the notification type


403

Forbidden

Returns WebhookResponse of type(s) application/json 
"WebhookResponse Object"
string As date-time As date-time
created
Optional

The creation date of entity.

string As date-time As date-time
updated
Optional

The update date of entity.

integer As int32 As int32
version
Optional

Version of this entity.

string As uuid As uuid
id
Optional

Unique ID for this entity.

object
web_hook_info
Required

web_hook_info

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string
name
Optional

name

array of string
providers
Required
Constraints: minItems: 1 maxItems: 2147483647

providers

string
contact
Optional

Team member email or slack channel to be contacted if needed

string As uuid As uuid
org_id
Optional

org_id

string
created_by
Optional

The username of the person/app who created the notification type

string
updated_by
Optional

The username of the person/app who updated the notification type


404

Not Found

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


500

Internal Server Error

Returns ErrorResponse of type(s) application/json 
"ErrorResponse Object"
object
messages
Optional

Message of Error

string
type
Optional

type


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Webhooks Operations
GET
Search Webhook
POST
Create Webhook
GET
Get Webhook
POST
Action Webhook
DELETE
Delete Webhook
PATCH
Update Webhook
GET
Get Webhook Template
POST
Create Webhook Template