Skip to content
Press.js Press.js Press.js Docs

Render job terminated

POST

Sent after a render job reaches a terminal state. Successful jobs include data.output and a signed data.output.download.url valid for 10 minutes from each delivery attempt; failed jobs include final error metadata and no output; canceled jobs include no output.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters ”
Press-Webhook-Event
required
string
Allowed value: render.job.terminated

Stable event type for the webhook delivery.

Press-Webhook-Id
required
string
>= 1 characters

Stable idempotency key for the webhook delivery.

Press-Webhook-Delivery
required
string
>= 1 characters

Unique delivery attempt group id for retry tracking.

Press-Webhook-Attempt
required
integer
>= 1

One-based delivery attempt number.

Press-Webhook-Timestamp
required
integer
>= 1

Unix timestamp in seconds used by the webhook signature.

Press-Webhook-Signature
string
/^v1=[a-f0-9]{64}$/

HMAC-SHA256 signature over ${timestamp}.${rawBody} when a signing secret is configured.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
id
required
string
>= 1 characters
type
required
string
Allowed value: render.job.terminated
occurredAt
required
integer
data
required
object
job
required
object
id
required
string
status
required
string
Allowed values: succeeded failed canceled
deployId
required
string
deployVersionId
required
string
deployVersionNo
integer
deployVersionRoute
string
deployVersionTitle
string
businessKey
required
string
payloadHash
required
string
attempt
required
integer
requestedAt
required
integer
startedAt
integer
finishedAt
required
integer
outputMode
required
string
Allowed values: transient managed
errorCode
string
errorMessage
string
output
object
id
required
string
renderJobId
required
string
contentType
required
string
Allowed value: application/pdf
fileName
required
string
>= 1 characters
sha256
required
string
>= 1 characters
bytes
required
integer
pageCount
integer
>= 1
download
required
object
url
required
string format: uri
>= 1 characters
expiresAt
required

Unix epoch time in milliseconds. The signed URL expires 10 minutes after the webhook delivery attempt is generated.

integer
accessGuaranteedUntil
integer
pdf
object
id
required
string
state
required
string
Allowed values: available deleting deleted

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Webhook processed.

202

Section titled “202 ”

Webhook accepted for asynchronous processing.

204

Section titled “204 ”

Webhook acknowledged without a response body.