Überblick
Anstatt wiederholtGET /jobs/{id} zu pollen, kannst du eine Webhook-URL angeben, um eine POST-Anfrage zu erhalten, sobald dein Job abgeschlossen ist. Das ist effizienter und reduziert unnötige API-Aufrufe.
Webhooks verwenden
Füge denX-Webhook-URL-Header zu einer beliebigen Generierungsanfrage hinzu. Sobald der Job einen Endzustand erreicht (completed, failed oder cancelled), sendet die API eine POST-Anfrage an deine URL mit den vollständigen Job-Daten.
Webhook-Payload
Sobald der Job abgeschlossen ist, empfängt deine Webhook-URL eine POST-Anfrage mit den Job-Daten:Best Practices
Schnell antworten – Gib zügig einen 2xx-Statuscode zurück. Verarbeite die Webhook-Daten bei Bedarf asynchron.
- Nutze HTTPS-Endpoints für die Sicherheit
- Implementiere Idempotenz für den Fall doppelter Zustellungen
- Logge Webhook-Empfänge für das Debugging
Webhooks vs. Polling
| Ansatz | Vorteile | Nachteile |
|---|---|---|
| Webhooks | Echtzeit-Benachrichtigungen, weniger API-Aufrufe | Erfordert einen öffentlichen Endpoint |
| Polling | Funktioniert überall, kein Server nötig | Mehr API-Aufrufe, leichte Verzögerung |
Nächste Schritte
Job-Lebenszyklus
Erfahre mehr über Job-Status und Status-Polling
Codebeispiele
Sieh dir vollständige Beispiele mit Webhook-Handling an