VoidhashDocs
DevelopersHelp centerGuidesAPI reference
Dashboard
Essentials
API overview
Authentication
Event capture
Push device API
Webhooks
Webhook delivery
Webhook events
Projects & keys
Projects
API keys
Audit log
Customers & access
Persons
Products
Perks
Sandbox
Paywalls
Paywalls
Paywall locations
Components
Component registry
Assets
Experiments & flags
Experiments
Feature flags
Analytics & events
Analytics
Analytics alerts
Events
Ingest policy
VoidQL
Tracking domains
Ads
Ads
Ad accounts
Meta measurement
Payments & stores
Payment providers
Payment provider products
Purchase history imports
Payment sources
Webhooks & notifications
Webhooks
Push notifications
Push configurations
Automations
Organization & team
Organizations
Members
Invitations
Billing
Your account
Profile
Session
Notices
Connected apps
Terms of Service
Developer tools
Schema
SDK
List webhooks
Create a webhook
Retrieve a webhook
Update a webhook
Delete a webhook
Rotate a webhook's secret
Send a test event
List a webhook's deliveries
Retrieve a webhook delivery
Retry a webhook delivery

Retrieve a webhook

Reads one webhook, without its secret.

Guide: Webhook delivery

GET
/api/v1/projects/{projectId}/webhooks/{webhookId}

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 GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/webhooks/wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5" \  -H "Authorization: Bearer vh_sk_..."
{  "id": "wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "name": "Orders backend",  "description": null,  "url": "https://example.com/webhooks/voidhash",  "events": [    "subscription.created",    "subscription.renewed",    "purchase.refunded"  ],  "environment": "production",  "status": "active",  "consecutiveFailures": 0,  "lastSuccessAt": "2026-03-14T09:31:54.000Z",  "createdAt": "2026-03-01T10:00: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": "webhook_not_found",    "message": "This project has no webhook wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5.",    "param": "webhookId"  }}

{  "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."  }}

Response body

application/json

application/json

application/json

application/json

application/json

application/json

Errors

StatustypecodeWhen
404not_foundwebhook_not_foundWhen the project has no such webhook.

It can also fail with the errors every operation shares, such as unauthenticated; see Errors.

More in Webhooks

  • List webhooks GET
  • Create a webhook POST
  • Update a webhook PATCH
  • Delete a webhook DELETE
  • Rotate a webhook's secret POST
  • Send a test event POST
  • List a webhook's deliveries GET
  • Retrieve a webhook delivery GET
  • Retry a webhook delivery POST

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

PreviousCreate a webhookNextUpdate a webhook

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Webhooks