Create Webhook

Create Webhook

Endpoint to create new webhook configuration
Authorized Roles : PROVIDER

Request
URI
POST
https://{api_host}/provider/webhooks
COPY
Request Body
WebhookDto of type(s) application/json
Required 
{
    "id": "string",
    "name": "string",
    "url": "string",
    "endpointType": "string",
    "status": "string",
    "createdByUserEmail": "string",
    "lastModifiedTime": "string",
    "lastModifiedUserEmail": "string",
    "orgId": "string",
    "dbCount": 0,
    "dbStatusChangePayload": {
        "id": "string",
        "contentType": "string",
        "payload": "string",
        "alertDefinitionType": "string"
    },
    "dbOperationFailurePayload": {
        "id": "string",
        "contentType": "string",
        "payload": "string",
        "alertDefinitionType": "string"
    },
    "action": "string",
    "authUsername": "string",
    "authPassword": "string",
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
name
Required

name

string
url
Required

url

string
endpointType
Required

endpointType

Possible values are : SLACK, EMAIL, SERVICE_NOW, CUSTOM,
string
status
Optional

status

Possible values are : PUBLISHED, UNPUBLISHED,
string
createdByUserEmail
Optional

createdByUserEmail

string As date-time As date-time
lastModifiedTime
Optional

lastModifiedTime

string
lastModifiedUserEmail
Optional

lastModifiedUserEmail

string As uuid As uuid
orgId
Optional

orgId

integer As int64 As int64
dbCount
Optional

dbCount

WebhookPayloadDto
dbStatusChangePayload
Required

dbStatusChangePayload

WebhookPayloadDto
dbOperationFailurePayload
Required

dbOperationFailurePayload

string
action
Required

action

Possible values are : POST, PUT,
string
authUsername
Optional

authUsername

string
authPassword
Optional

authPassword

object
headers
Optional

headers

array of Link
links
Optional

links

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns WebhookDto of type(s) application/vnd.vmware.dms-v1+json 
{
    "id": "string",
    "name": "string",
    "url": "string",
    "endpointType": "string",
    "status": "string",
    "createdByUserEmail": "string",
    "lastModifiedTime": "string",
    "lastModifiedUserEmail": "string",
    "orgId": "string",
    "dbCount": 0,
    "dbStatusChangePayload": {
        "id": "string",
        "contentType": "string",
        "payload": "string",
        "alertDefinitionType": "string"
    },
    "dbOperationFailurePayload": {
        "id": "string",
        "contentType": "string",
        "payload": "string",
        "alertDefinitionType": "string"
    },
    "action": "string",
    "authUsername": "string",
    "authPassword": "string",
    "links": [
        {
            "rel": "string",
            "href": "string",
            "hreflang": "string",
            "media": "string",
            "title": "string",
            "type": "string",
            "deprecation": "string",
            "profile": "string",
            "name": "string"
        }
    ]
}
string As uuid As uuid
id
Optional

id

string
name
Required

name

string
url
Required

url

string
endpointType
Required

endpointType

Possible values are : SLACK, EMAIL, SERVICE_NOW, CUSTOM,
string
status
Optional

status

Possible values are : PUBLISHED, UNPUBLISHED,
string
createdByUserEmail
Optional

createdByUserEmail

string As date-time As date-time
lastModifiedTime
Optional

lastModifiedTime

string
lastModifiedUserEmail
Optional

lastModifiedUserEmail

string As uuid As uuid
orgId
Optional

orgId

integer As int64 As int64
dbCount
Optional

dbCount

WebhookPayloadDto
dbStatusChangePayload
Required

dbStatusChangePayload

WebhookPayloadDto
dbOperationFailurePayload
Required

dbOperationFailurePayload

string
action
Required

action

Possible values are : POST, PUT,
string
authUsername
Optional

authUsername

string
authPassword
Optional

authPassword

object
headers
Optional

headers

array of Link
links
Optional

links


400

Bad Request

Operation doesn't return any data structure

On This Page
Webhooks Operations
POST
Create Webhook
DELETE
Delete Webhook
PUT
Edit Webhook
GET
Get Page
GET
Get Webhook By Id
GET
Get Webhook Endpoint Types
GET
Get Webhook Params
GET
Get Webhook Template Payload
PUT
Publish Webhook
POST
Test Webhook
DELETE
Unpublish Webhook