Send a test event

Sends a test.ping event to the webhook in the background and answers 202 with its delivery, so you can check signing and connectivity.

Read the delivery to see how the webhook answered.

Guide: Webhook delivery

Errors

This operation adds no error codes of its own. It can fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Webhooks

Something wrong or missing on this page? Tell us by email or on Discord.

PreviousRotate a webhook's secret NextList a webhook's deliveries

On this page

Authorization Path parameters Examples Response body Errors More in Webhooks

Authorization

AuthorizationBearer <token>

A project secret key: vh_sk_... for production, vh_sk_test_... for test. Keep it on your servers.

In: header

Path parameters

projectId*string

The project's id, proj_.... A secret key works only in the project it belongs to.

webhookId*string

The webhook's id, wh_ep_....

Examples

curl -X POST "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/webhooks/wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5/test" \  -H "Authorization: Bearer vh_sk_..."

{  "id": "wh_del_c9v2b5n8m1q4w7e0r3t6z3x6",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "webhookId": "wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5",  "eventType": "test.ping",  "payload": {    "message": "This is a test webhook delivery",    "timestamp": "2026-03-01T10:02:00.000Z"  },  "status": "pending",  "attemptCount": 0,  "maxAttempts": 5,  "eventOccurredAt": "2026-03-01T10:02:00.000Z",  "nextAttemptAt": null,  "completedAt": null,  "createdAt": "2026-03-01T10:02:00.000Z"}

{  "error": {    "type": "invalid_request",    "code": "string",    "message": "string",    "param": "string"  }}

{  "error": {    "type": "unauthenticated",    "code": "invalid_api_key",    "message": "This secret key is not valid."  }}

{  "error": {    "type": "permission_denied",    "code": "permission_denied",    "message": "Insufficient permissions."  }}

{  "error": {    "type": "not_found",    "code": "project_not_found",    "message": "There is no project proj_tz4a98xxat96iws9zmbrgj3a, or this credential cannot use it.",    "param": "projectId"  }}

{  "error": {    "type": "internal",    "code": "internal_error",    "message": "Something went wrong on our side. Try again, and contact support with the Request-Id header if it keeps failing."  }}

Send a test event

Errors

More in Webhooks

Send a test event

Errors

More in Webhooks

Authorization

Path parameters

Examples

Response body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Send a test event

Send a test event

202application/json

400application/json

401application/json

403application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`