Skip to main content
WEBHOOK
pdf.failed
{
  "success": false,
  "event": "PDF_GENERATION_FAILED",
  "requestId": "req_123",
  "mode": "async",
  "errorCode": "500",
  "subCode": "PDF_GENERATION_FAILED",
  "message": "PDF generation failed",
  "details": "Template compilation error",
  "meta": {
    "issues": []
  },
  "timestamp": "2025-09-14T12:34:56Z"
}

Authorizations

​
X-API-KEY
string
header
required

Headers

​
svix-id
string
required

Unique message identifier; constant on retries.

​
svix-timestamp
string
required

UNIX timestamp (seconds) when the webhook was sent.

​
svix-signature
string
required

HMAC-SHA256 signature(s) over "{id}.{timestamp}.{payload}". Format: space-delimited list of "v,<base64_signature>" (e.g. "v1,abc...").

Body

application/json
​
success
boolean
required
Example:

false

​
event
enum<string>
required
Available options:
PDF_GENERATION_FAILED
​
requestId
string
required

Correlation ID from original request

​
mode
enum<string>
required
Available options:
async
​
errorCode
enum<string>
required

Maps to HTTP status code class

Available options:
500
​
subCode
string
required

Specific error subcode

Example:

"PDF_GENERATION_FAILED"

​
message
string
required

Human-readable error message

​
timestamp
string<date-time>
required
​
details
string

Optional extra debug info

​
meta
object

Optional structured data

Example:
{
  "requiredCredits": 1,
  "availableCredits": 0,
  "issues": []
}

Response

200

Receipt acknowledged