Webhook Connectivity Check

POST 
/api/cloud/2.0/agg/notifications/profiles/webhook/test

Overview

Test webhook connectivity from the multi-tenant notification service to the provided notification webhook URL

Request

application/json

Body

urls string[]required

List of Webhook URLs - do not include token in the URL

authType stringrequired

Possible values: [NO_AUTH, TOKEN]

Webhook Authentication Type

token stringrequired

Webhook token value

Responses

201

Created

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "data": "Webhook Connectivity Check Success",
  "requestId": "8f29ba1a-3e5f-41a9-830f-20e4b1db9e19"
}

400

Bad Request

application/json

Schema

Schema

object

Example (from schema)

{}

example-0

Invalid Tenant List

{
  "requestId": "ec1c092c-c4da-40fb-86d7-12544715021c",
  "data": null,
  "error": {
    "httpStatus": 400,
    "errorCode": 60001,
    "errorType": "VALIDATION_ERROR",
    "msg": "Webhook must be valid https url"
  }
}

Loading...