Test webhook endpoint

POST

/v1/webhooks/endpoints/test

Test a webhook endpoint by sending a test payload (use before saving)

Authorization

headerX-API-Key<token>

API key authentication using X-API-Key header

An unsaved webhook URL and auth header to send a test event to

application/json

An unsaved webhook URL and auth header to send a test event to

url*string

authHeaderName?string

Lengthlength <= 100

authHeaderValue?string

Lengthlength <= 500

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/test' \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "string"
}'

Example Request

curl -X POST 'http://localhost:3003/v1/webhooks/endpoints/test' \  -H 'Content-Type: application/json' \  -d '{  "url": "string"}'

Example ResponseSchema

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

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