Sign in

v2

latestOpenAPI 3.1.02026-08-064686150.6 KB
Webhooks

Send a test event to a webhook endpoint

Relays the customer endpoint's response: the HTTP status mirrors theirs, and the body (httpStatus, latencyMs, success, error) reports the outcome. A 4xx/5xx means their endpoint responded that way, not that this API failed.

post/webhooks/configs/test

Request body

urlstring required

The customer endpoint URL to send a synthetic test event to

Example request

{
  "url": "https://customer.example.com/webhook"
}

Response

Endpoint returned 2xx.

httpStatusinteger

HTTP status returned by the customer endpoint, if any

latencyMsinteger

Round-trip latency in milliseconds

successboolean

Whether the customer endpoint returned a 2xx response

errorstring

Network-level error when no HTTP response was received

Example response

{
  "httpStatus": 200,
  "latencyMs": 87,
  "success": true,
  "error": "Connection refused"
}