Webhooks

Receive job and account events in your app.

Batch 11 includes webhook test scaffolding. Batch 12 documents the event format, signature expectations, retries, and safe receiver behavior for the go-live pass.

Read changelog Generate API key

Test endpoint

Use POST /v1/webhooks/test to record a webhook test request. Outbound delivery can be enabled in the go-live pass after admin controls are finalized.

Suggested events

Prepare for job.completed, job.failed, quota.warning, quota.exhausted, and api_key.revoked.

Receiver security

Verify signatures when enabled, reject old timestamps, respond quickly with 2xx, and process expensive work asynchronously.

Idempotency

Webhook receivers should deduplicate by event ID so retries do not trigger duplicate customer actions.

curl -X POST https://fileza.ai/v1/webhooks/test \
  -H "Authorization: Bearer fpe_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/webhooks/freepdfeditor"}'

Need help?

Include your request ID, endpoint, timestamp, and account email when contacting support. Never send raw API keys, provider secrets, OAuth tokens, or signed download URLs.

Contact API support