GOgonitro
Webhooks

Send a test event to a webhook endpoint

Changed on

Relays the customer endpoint's response: the HTTP status mirrors theirs, and the body (httpStatus, latencyMs, success, error) reports the outcome. A 4xx/5xx usually means their endpoint responded that way; this API's own responses are 400 (validation), 429 problem+json with Retry-After (rate limit), and 502 (delivery service unreachable).

post/webhooks/configs/test

Request

  • Base URL
    https://api.gonitro.dev
  • URL
    https://api.gonitro.dev/webhooks/configs/test
  • Auth
    HTTP bearer

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"
}

Changes