API: Webhooks
Lass PenBlitz deinem System Bescheid geben, wenn ein Auftrag beendet ist, statt immer wieder nachzufragen.
So funktioniert es
Gib beim Anlegen eines Auftrags oder einer Bestellung eine callback_url an. Ist der Auftrag fertig, fehlgeschlagen oder abgebrochen, sendet PenBlitz eine POST-Anfrage mit JSON an diese Adresse.
POST /dein/endpunkt
Content-Type: application/json
{
"event": "job.finished",
"job": {
"id": "8c43d11a9e3c",
"name": "Gutschein mit QR",
"external_id": "A-1042",
"state": "done",
"pages_total": 2,
"pages_done": 2,
"progress": 1.0,
"error": null,
"warnings": 0
}
}Womit du rechnen musst
- Das Ereignis heißt immer job.finished; das Feld state sagt, wie es ausging: done, failed oder canceled.
- Die Anfrage wird einmal gesendet und wartet bis zu 10 Sekunden. Sie wird nicht wiederholt.
- Weil eine Benachrichtigung verloren gehen kann, frag den Zustand ab, wenn keine ankommt.
- Deine Adresse muss von dem Rechner aus erreichbar sein, auf dem PenBlitz läuft.