Zum Hauptinhalt gehen
Zurück an den Anfang

Was sind Webhooks und wie richtet man sie in Sendcloud ein?

Joan
  • Aktualisiert

Zweck: Erfahre die Grundlagen über Webhooks und wie du sie in deinem Sendcloud-Panel konfigurieren kannst.

Um Webhooks nutzen zu können, musst du dich über eine API mit Sendcloud verbinden. Für weitere Informationen zur Verbindung mit unserer API verweisen wir dich auf unsere API-Dokumentation.

Weitere Informationen zu Sendcloud-Webhooks findest du in den Abschnitten über Webhooks in unserer API-Dokumentation.

Was sind Webhooks?

Webhooks ermöglichen es Anwendungen, in "Echtzeit" miteinander zu kommunizieren. Eine andere Möglichkeit für Anwendungen, miteinander zu kommunizieren, ist über eine API. Im Gegensatz zu einer API, die mit Polling arbeitet, empfängt ein Webhook Daten, sobald die Anwendung sie verarbeitet. Es muss keine Anfrage gestellt werden, da es sich um einen automatischen Prozess handelt. Daher musst du dir keine Sorgen über eine Verzögerung bei der Kommunikation machen.

API: Eine API holt sich regelmäßig Daten aus der Anwendung, indem sie eine Anfrage stellt.

Webhook: Ein Webhook zieht keine Daten, sondern bekommt Daten von der Anwendung gepusht, sobald sie entstehen.

Beispiel: Empfang von Tracking-Updates von Sendcloud

(Siehe Bilder unten als Referenz)

  1. Wenn du ein Tracking-Update über die API erhältst, läuft es wie folgt ab:
    Deine Anwendung versucht, Tracking-Daten von Sendcloud über ein Intervall zu beziehen. Das tut sie auch, wenn keine neuen Daten verfügbar sind.
  2. Wenn du Tracking-Updates über einen Webhook erhalten möchtest, geht das wie folgt:
    Sendcloud schickt die Tracking-Updates an deine Anwendung, sobald sie in Sendcloud verfügbar sind.

Sendcloud Webhooks

Webhook Integration Object: Dieser Webhook kommt ins Spiel, wenn eine neue API-Integration zu Sendcloud hinzugefügt wird. Er wird ausgelöst, wenn eine API-Integration verbunden, gelöscht oder aktualisiert wird. Klicke hier, um zu sehen, was in der Nutzlast dieses Webhooks enthalten ist.

Webhook Object „Paketstatus geändert“: Dieser Webhook wird aktiviert, wenn sich der Status eines Pakets ändert, unabhängig davon, wie sich der Status ändert. Klicke hier, um zu sehen, was in der Nutzlast dieses Webhooks enthalten ist.

Webhook Refund Requested Object: Dieser Webhook kommt ins Spiel, wenn eine Rückerstattung angefordert wird. Klicke hier, um zu sehen, was in der Nutzlast dieses Webhooks enthalten ist.

Wie richte ich Webhooks in Sendcloud ein?

Damit Sendcloud aktiv Paketaktualisierungen (z. B. Tracking-Updates) übermittelt, musst du einen API-Endpunkt erstellen. Jedes Mal, wenn eine Aktualisierung stattfindet, stellt Sendcloud eine Anfrage über diesen Endpunkt. Weitere Informationen findest du im Abschnitt Webhooks in unserer API-Dokumentation.

  1. Kopiere die Webhook-URL aus deiner Anwendung in deine Zwischenablage
  2. Gehe zu deinem Sendcloud-Panel und öffne deine Integrationseinstellungen, indem du zu Einstellungen > Integrationen > Konfigurieren gehst.
  3. Aktiviere das Kästchen bei Webhook-Feedback aktiviert
  4. Suche das Feld Webhook-URL (siehe Abbildung unten) und füge die Webhook-URL dort ein
  5. Teste deinen Webhook, indem du auf die Schaltfläche Test API webhook Button klickst.
  6. Klicke auf Speichern

Geschafft! Dein Webhook ist nun eingerichtet und die Daten sollten nun in deiner Anwendung ankommen. Du kannst dies nutzen, um Trigger einzurichten, die zu bestimmten Aktionen führen. Ein Beispiel wäre, dass du deine Tracking-E-Mails mit den eingehenden Tracking-Updates verbindest. Auf diese Weise kannst du deinen Kunden sofortige Updates zukommen lassen.

Für Retourenpakete erhältst du nur dann Webhook-Updates, wenn die ausgehende Sendung über den API Shop erstellt wurde.

Klicke hier, um zu unserer Sendcloud-API-Referenz zu gelangen und die Payload des Webhooks zu sehen.