Send a test webhook delivery
Download OpenAPI specEnqueue a test webhook delivery to a URL you control. Useful for verifying that your endpoint is reachable and that signature verification works before running real validations.
The delivery arrives as event: "test" with data: { "message": "This is a test event." },
and is signed with the same X-Signature header — and the same account signing secret —
as production events (t=<unixSeconds>,v1=<hex>; see components.headers.X-Signature for
the verification recipe and the freshness window). So the secret you pin for production
verifies a test event unchanged. It arrives at your URL within seconds.
The response returns the event_id the delivery will carry as its envelope id, so you can
match the event your endpoint receives to the call that produced it.
Request body · application/json · required
| Field | Type | Description |
|---|---|---|
| callback_url required | string · uri | HTTPS URL to deliver the test event to. example: https://yourapp.example.com/hooks/email |
Responses
callback_url.
· application/json
code: insufficient_scope). It is a 403 rather than a 401 on purpose — the credential is valid, so retrying with it can never help; a key holding the verify scope is needed.
· application/json
Response schema · 202
| Field | Type | Description |
|---|---|---|
| status required | string |
queued
|
| event_id required | string |
The envelope id the delivered test event will carry — use it to correlate this call with the event your endpoint receives, and to find the delivery in your log.
example: evt_3a4b5c6d...
|
Error responses
400 401 403 429 500 · ApiProblem · object
| Field | Type | Description |
|---|---|---|
| status required | integer | HTTP status code mirrored in the body. example: 400 |
| code required | string |
Stable, machine-readable error code. Branch your code on this — never on the error text, which is prose and may be reworded at any time.
example: invalid_email
|
| error required | string | Human-readable error message. example: Invalid email format. |
| param | string | The request field the failure is attributable to. Omitted when the failure is not about one specific field. example: email |
| details | array of string · null | Optional per-field validation messages. Null when not applicable. example: ["email: required"] |
| doc_url | string | Link to the documentation for this error code. example: https://emailvalidator.ai/docs/get-started/errors |
| request_id | string | Correlation id for this request. Quote it in a support request — it is how a single call is found in the server logs. example: 0HNCV1TQ3PLRK:00000003 |
Example response · 202
{
"status": "queued",
"event_id": "evt_3a4b5c6d..."
}