Send Test Event

POST/v2/webhooks/{id}/test

Sends a signed webhook.test event now and reports whether it was delivered, the HTTP status class and a coarse error code. Works on a paused or disabled webhook too, so a fixed receiver can be checked before re-activating it. 10 per webhook and 30 per workspace per minute. Free: no credits.

Path parameters

idstringrequired
The webhook id (24 hex characters).

Responses

200 The outcome of the test event.
400 Malformed webhook id (VALIDATION_ERROR, payload.code: invalid_format).
401 Missing, unknown or inactive credentials (UNAUTHORIZED).
404 No such webhook in this workspace (NOT_FOUND).
429 Over 10 test events per webhook or 30 per workspace in this minute (RATE_LIMIT); wait Retry-After seconds.
500 Unexpected server error.
503 Webhook delivery is not enabled for this workspace yet (UNAVAILABLE, payload.code: temporarily_disabled).

For error handling see Errors. Response objects are described in Person object and Company object.

curl --request POST \
  --url https://api.getprospect.com/v2/webhooks/{id}/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: YOUR_API_KEY'

Response

{
  "success": true,
  "data": {
    "delivered": true,
    "status_class": "2xx",
    "error_code": null
  },
  "metadata": {
    "timestamp": "2026-10-08T12:00:00.000Z"
  }
}