webhook.test delivery to the webhook’s URL, signed with its secret exactly like any other delivery, and returns the result. Use it to check that your endpoint is reachable and verifies signatures.
The test is a single attempt: no retries, and it does not change the webhook’s failure_count.
Authentication
API key or session token with thewebhooks:read permission. API keys have it. The delivery’s environment is sandbox when you call with a wede_test_ key, otherwise production.
Path parameters
string
required
Webhook ID (UUID).
Example
Response
200 OK, whether or not your endpoint accepted the delivery. Check success.
string
The webhook tested.
string
ID of the test delivery. Same value as the
X-Wede-Delivery header and the envelope id.boolean
true if your endpoint answered with a 2xx status.integer | null
HTTP status your endpoint returned.
null if no response was received.integer
Time until wede had the result, in milliseconds.
string | null
Network error when no response was received (for example a timeout after 10 seconds or a DNS failure), otherwise
null.