Webhooks
Webhooks Übersicht
Verwenden Sie Webhooks, um Echtzeit-Updates von der Curosa-Plattform zu erhalten
Überblick
Webhooks ermöglichen es Curosa, Ereignisbenachrichtigungen in Echtzeit an Ihr System zu senden. Anstatt API-Endpunkte wiederholt abzufragen (Polling), können Sie Ereignisse abonnieren und Updates verarbeiten, sobald sie auftreten.
Funktionsweise von Webhooks
- Sie konfigurieren einen öffentlichen HTTPS-Endpunkt in Ihrem Lieferantenportal.
- Sie abonnieren mit diesem Endpunkt einen oder mehrere Ereignistypen.
- Wenn ein Ereignis eintritt, sendet Curosa eine
POST-Anfrage mit einer JSON-Nutzlast an Ihren Endpunkt. - Ihr Endpunkt gibt eine
2xx-Antwort zurück, um die erfolgreiche Verarbeitung zu bestätigen.
Übertragungsformat
Webhook-Anfragen werden als JSON gesendet:
| Eigenschaft | Wert |
|---|---|
| Methode | POST |
| Header | Content-Type: application/json |
| Body | Ereignis-Nutzlast |
Die Struktur der Nutzlast und ereignisspezifische Felder sind unter Webhook Events dokumentiert.
Anforderungen an den Endpunkt
Ihr Webhook-Endpunkt sollte:
- Öffentlich über HTTPS erreichbar sein
- Schnell eine
2xx-Antwort zurückgeben, wenn Nutzlasten akzeptiert wurden - Wiederholungsversuche sicher handhaben (idempotente Verarbeitung empfohlen)
- Fehlerhafte Anfragen für das betriebliche Monitoring protokollieren
Sicherheitsempfehlungen
- Überprüfen Sie vor der Verarbeitung, ob eingehende Anfragen von einer vertrauenswürdigen Infrastruktur stammen
- Behandeln Sie Webhook-Nutzlasten als nicht vertrauenswürdige Eingaben und validieren Sie die Felder
- Vermeiden Sie aufwendige Verarbeitungen direkt im Antwortzyklus; stellen Sie Aufgaben nach Möglichkeit in eine Warteschlange (Queue)
- Verwenden Sie ausschließlich HTTPS und geben Sie niemals Geheimnisse in Webhook-URLs preis
Wiederholungsverhalten
Wenn Ihr Endpunkt einen Statuscode zurückgibt, der nicht 2xx ist, oder eine Zeitüberschreitung auftritt, kann die Zustellung gemäß der Warteschlangenkonfiguration wiederholt werden. Entwerfen Sie Handler idempotent, damit doppelte Zustellungen sicher sind.
Nächste Schritte
- Überprüfen Sie die unterstützten Ereignisse unter Webhook Events
- Implementieren Sie das Ereignis-Routing basierend auf dem Feld
eventin der Anfrage-Nutzlast