Get Webhook

Get Webhook

Returns the specified webhook subscriber within the specified organization.

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

Org ID

string
webhook
Required

Webhook identifier


Authentication
This operation uses the following authentication methods.
Responses
200

OK

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

Team member email or slack channel to be contacted if needed

string As date-time As date-time
created
Optional

The creation date of entity.

string
created_by
Optional

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

string As uuid As uuid
id
Optional

Unique ID for this entity.

string
name
Optional

name

string As uuid As uuid
org_id
Optional

org_id

array of string
providers
Required

providers

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string As date-time As date-time
updated
Optional

The update date of entity.

string
updated_by
Optional

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

integer As int32 As int32
version
Optional

Version of this entity.

web_hook_info
Required

web_hook_info


400

Bad Request

Returns ErrorResponse of type(s) application/json
{
    "messages": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "type": "string"
}
messages
Optional

messages

string
type
Optional

type


401

Unauthorized

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

Team member email or slack channel to be contacted if needed

string As date-time As date-time
created
Optional

The creation date of entity.

string
created_by
Optional

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

string As uuid As uuid
id
Optional

Unique ID for this entity.

string
name
Optional

name

string As uuid As uuid
org_id
Optional

org_id

array of string
providers
Required

providers

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string As date-time As date-time
updated
Optional

The update date of entity.

string
updated_by
Optional

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

integer As int32 As int32
version
Optional

Version of this entity.

web_hook_info
Required

web_hook_info


403

Forbidden

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

Team member email or slack channel to be contacted if needed

string As date-time As date-time
created
Optional

The creation date of entity.

string
created_by
Optional

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

string As uuid As uuid
id
Optional

Unique ID for this entity.

string
name
Optional

name

string As uuid As uuid
org_id
Optional

org_id

array of string
providers
Required

providers

string
status
Required

The status of the webhook.

Possible values are : ACTIVE, INACTIVE,
string As date-time As date-time
updated
Optional

The update date of entity.

string
updated_by
Optional

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

integer As int32 As int32
version
Optional

Version of this entity.

web_hook_info
Required

web_hook_info


404

Not Found

Returns ErrorResponse of type(s) application/json
{
    "messages": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "type": "string"
}
messages
Optional

messages

string
type
Optional

type


500

Internal Server Error

Returns ErrorResponse of type(s) application/json
{
    "messages": {
        "args": [
            "string"
        ],
        "default_message": "string",
        "id": "string"
    },
    "type": "string"
}
messages
Optional

messages

string
type
Optional

type