Skip to main content
POST
Create a webhook

Authorizations

Authorization
string
header
required

Your secret key as a bearer token, e.g. Authorization: Bearer sk_live_…. Secret keys are server-side only.

Query Parameters

dryRun
boolean
default:false

Validate and check references without saving: the response shows the record as it would be saved.

Body

application/json

An HTTPS endpoint FileCheck calls when events happen on your account: jobs created, completed or delivered, proofs ready or approved, settings changed, credits running low. Each call is a JSON POST signed with X-FileCheck-Signature (the hex HMAC-SHA256 of the raw body, keyed with your Auth Key). Delivery is attempted once; the webhook records the last status it got.

url
string<uri>
required

The HTTPS URL that receives the POSTs.

Maximum string length: 2048
Pattern: ^https://
events
string[]
required

The event keys this webhook receives, from GET /webhook-events (for example job.completed, proof.ready).

Minimum array length: 1
Minimum string length: 1
headers
object

Extra request headers sent with every call, such as an Authorization header your endpoint checks. Values are write-only: they read back as ********.

description
string

A note for yourself: what the endpoint is for.

Maximum string length: 500

Response

OK

webhook
Webhook · object

An HTTPS endpoint FileCheck calls when events happen on your account: jobs created, completed or delivered, proofs ready or approved, settings changed, credits running low. Each call is a JSON POST signed with X-FileCheck-Signature (the hex HMAC-SHA256 of the raw body, keyed with your Auth Key). Delivery is attempted once; the webhook records the last status it got.

dryRun
boolean

Present and true when nothing was saved.