Skip to content
Docs

Test Webhook

Send a signed webhook.test event to the webhook's URL now.

POST/api/v1/webhooks/{webhook_id}/test

Requires an API key with the write scope.

Makes an outbound HTTP request from FoxReach and waits up to 10 seconds. The event is signed exactly like a real delivery (see Signatures). The response reports the HTTP status your endpoint answered with and how long it took; it never includes what your endpoint replied with. A test does not create a delivery record. The URL must resolve to a public address and redirects are not followed.

Path Parameters#

webhook_idstringpathrequired

The unique identifier of the webhook.

Response#

dataobject
Show data
successboolean
true when the endpoint answered with a 2xx status.
statusCodeinteger
The HTTP status code, or null when no response was received.
durationMsinteger
How long the request took. Present when a response was received.
errorstring
Why no response was received. Present when statusCode is null.
errorCodestring
target_not_public, invalid_url, timeout or connection_error.

Errors#

StatusDescription
401Missing, invalid, revoked or expired API key
403API key does not have the required scope: write
404Webhook not found in this workspace

Rate Limit#

  • 100 requests per minute, shared by every expensive call in your workspace. Fixed 60-second window.
  • Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (expensive).
  • A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Was this page helpful?
View as MarkdownLast updated November 4, 2026