Skip to content
PenBlitz
← Developers

API: webhooks

Let PenBlitz tell your system when a job is finished instead of asking again and again.

How it works

Give a callback_url when you create a job or an order. When the job is done, has failed or was canceled, PenBlitz sends one POST request with JSON to that address.

POST /your/endpoint
Content-Type: application/json

{
  "event": "job.finished",
  "job": {
    "id": "8c43d11a9e3c",
    "name": "Voucher with QR",
    "external_id": "A-1042",
    "state": "done",
    "pages_total": 2,
    "pages_done": 2,
    "progress": 1.0,
    "error": null,
    "warnings": 0
  }
}

What to expect

  • The event is always job.finished; the state field says how it ended: done, failed or canceled.
  • The request is sent once and waits up to 10 seconds. It is not repeated.
  • Because a notification can be lost, ask for the state again if none arrives.
  • Your address must be reachable from the computer PenBlitz runs on.