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 delivery

Reads a delivery with every attempt made for it, including the webhook's status codes and response bodies.

Guide: Webhook delivery

GET
/api/v1/projects/{projectId}/webhook-deliveries/{deliveryId}

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.

deliveryId*string

The delivery's id, wh_del_....

Examples

curl -X GET "https://api.voidhash.com/api/v1/projects/proj_tz4a98xxat96iws9zmbrgj3a/webhook-deliveries/wh_del_z3x6c9v2b5n8m1q4w7e0r3t6" \  -H "Authorization: Bearer vh_sk_..."
{  "id": "wh_del_z3x6c9v2b5n8m1q4w7e0r3t6",  "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",  "webhookId": "wh_ep_q5w8e2r7t1y4u9i3o6p0a2s5",  "eventType": "subscription.created",  "payload": {    "type": "subscription.created",    "projectId": "proj_tz4a98xxat96iws9zmbrgj3a",    "personId": "person_h7d2k9m4x1c6v8b3n5q0w2e7",    "distinctId": "user_8231",    "productId": "prod_x8k2m5q9v3n7c1z4w6e0r2t5",    "productSlug": "pro_monthly",    "providerProductId": "com.example.pro_monthly",    "provider": "apple-app-store",    "source": null,    "verified": true,    "environment": "production",    "occurredAt": "2026-03-14T09:26:53.000Z",    "subscriptionId": "sub_p9o3i7u1y5t8r2e6w0q4a8s2",    "status": "active",    "providerSubscriptionId": "2000000123456789",    "providerTransactionId": "2000000123456789",    "purchasedAt": "2026-03-14T09:26:53.000Z",    "startsAt": "2026-03-14T09:26:53.000Z",    "expiresAt": "2026-04-14T09:26:53.000Z",    "isTrial": false,    "amount": {      "currency": "USD",      "grossAmount": 499    }  },  "status": "succeeded",  "attemptCount": 2,  "maxAttempts": 5,  "eventOccurredAt": "2026-03-14T09:26:53.000Z",  "nextAttemptAt": null,  "completedAt": "2026-03-14T09:31:54.000Z",  "createdAt": "2026-03-14T09:26:53.000Z",  "attempts": [    {      "id": "wh_att_g6h9j2k5l8z1x4c7v0b3n6m9",      "attemptNumber": 1,      "isSuccessful": false,      "statusCode": 503,      "responseBody": "Service Unavailable",      "errorMessage": null,      "durationMs": 412,      "createdAt": "2026-03-14T09:26:54.000Z"    },    {      "id": "wh_att_q1w4e7r0t3y6u9i2o5p8a1s4",      "attemptNumber": 2,      "isSuccessful": true,      "statusCode": 200,      "responseBody": null,      "errorMessage": null,      "durationMs": 168,      "createdAt": "2026-03-14T09:31:54.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_delivery_not_found",    "message": "This project has no webhook delivery wh_del_c9v2b5n8m1q4w7e0r3t6z3x6.",    "param": "deliveryId"  }}

{  "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_delivery_not_foundWhen the project has no such delivery.

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
  • Retrieve a webhook GET
  • 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
  • Retry a webhook delivery POST

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

PreviousList a webhook's deliveriesNextRetry a webhook delivery

On this page

AuthorizationPath parametersExamplesResponse bodyErrorsMore in Webhooks