Test existing webhook endpoint

POST

/v1/webhooks/endpoints/{id}/test

Test an existing webhook endpoint by ID

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

id*number

Default Response

application/json

Result of sending a test notification

success*boolean

Whether the test was delivered

statusCode?number

HTTP status from the target, when one responded

error?string

Why the test failed, in plain language

responseTime*number

Time the test took, in milliseconds

Example Request

curl -X POST 'http://localhost:3003/v1/webhooks/endpoints/0/test'

Example Request

curl -X POST 'http://localhost:3003/v1/webhooks/endpoints/0/test'

Example ResponseSchema

{
  "success": true,
  "statusCode": 0,
  "error": "string",
  "responseTime": 0
}

{  "success": true,  "statusCode": 0,  "error": "string",  "responseTime": 0}