Was Webhooks tun
Ein Webhook ist ein Abonnement für ein bestimmtes Shop-Ereignis. Wenn dieses Ereignis eintritt, sendet Storeep die Ereignisdaten sofort an eine von Ihnen angegebene URL (API-Typ) oder eine von Ihnen angegebene E-Mail-Adresse (E-Mail-Typ). Webhooks werden häufig für Bestellverfolgungs-Integrationen, CRM-Synchronisierungen, Werbeplattform-Konversionen und automatisierte Benachrichtigungen verwendet.
Um Webhooks zu verwalten, gehen Sie zu Einstellungen → Webhooks.
Webhook-Limits
- Maximal 20 Webhooks pro Shop. Der Versuch, einen 21. hinzuzufügen, gibt einen Fehler zurück.
- Webhooks werden vom neuesten zum ältesten aufgelistet, mit 40 Einträgen pro Seite.
Einen Webhook erstellen
Klicken Sie auf Neuen Webhook hinzufügen.
Aktivierungsschalter
Wenn aktiviert (Standard), ist der Webhook ab dem Moment des Speicherns live. Ereignisse werden sofort gesendet. Deaktivieren Sie die Option, um den Webhook in einem deaktivierten Zustand zu speichern, ohne Ereignisse zu empfangen. Sie können einen Webhook jederzeit durch Bearbeiten aktivieren oder deaktivieren.
Name
- Erforderlich.
- Maximal 50 Zeichen.
- Eine beschreibende Bezeichnung, die in der Webhook-Liste angezeigt wird. Beispiel: Facebook CAPI, Bestellung erstellt.
Typ
Steuert, wie die Ereignisnutzlast zugestellt wird. Zwei Optionen:
- API: Storeep sendet eine HTTP-POST-Anfrage mit den Ereignisdaten an die von Ihnen angegebene URL.
- E-Mail: Storeep sendet eine E-Mail mit den Ereignisdaten an die von Ihnen angegebene Adresse.
Ereignis
Das Shop-Ereignis, das diesen Webhook auslöst. Drei Ereignisse stehen zur Verfügung:
- Sitzung erstellt: wird ausgelöst, wenn eine neue Besuchersitzung in Ihrem Shop erstellt wird.
- Bestellung erstellt: wird ausgelöst, wenn eine neue Bestellung aufgegeben wird.
- Bestellung aktualisiert: wird ausgelöst, wenn sich Status oder Daten einer bestehenden Bestellung ändern.
Format
Das Datenformat der Ereignisnutzlast. Aktuell eine Option:
- Json: die Nutzlast wird als JSON-Dokument gesendet.
URL (nur API-Typ)
- Erforderlich, wenn der Typ API ist.
- Maximal 500 Zeichen. Das höhere Limit berücksichtigt URLs, die mehrere Platzhaltersegmente enthalten.
- Geben Sie die Endpunkt-URL ohne das Präfix
https://ein. Es wird automatisch hinzugefügt. Beispiel:api.example.com/events/order. - Dynamische URL-Platzhalter: Jedes Feld aus der Ereignisnutzlast kann mithilfe der doppelten Klammern-Syntax in die URL eingefügt werden:
{{field_name}}. Zum Beispiel:https://example.com/postback?cid={{fbclid}}&payout={{order_total}}
So können Sie Konversionsdaten direkt über die Webhook-URL an Werbeplattformen senden, ohne einen separaten Proxy-Server. - Wenn die URL-Struktur nach der Auflösung der Platzhalter ungültig ist, erhalten Sie einen Validierungsfehler.
E-Mail-Adresse (nur E-Mail-Typ)
- Erforderlich, wenn der Typ E-Mail ist.
- Muss eine gültige E-Mail-Adresse sein, maximal 127 Zeichen.
Einen Webhook bearbeiten
Klicken Sie auf eine beliebige Webhook-Zeile, um den Editor zu öffnen. Alle Felder sind bearbeitbar. Das URL-Feld wird nur vorausgefüllt, wenn der aktuelle Typ API ist; das E-Mail-Feld wird nur vorausgefüllt, wenn der aktuelle Typ E-Mail ist. Ein Typwechsel löscht das jeweils andere Feld.
Webhooks aktivieren und deaktivieren
Das Kontrollkästchen Aktivieren oben im Editor steuert, ob der Webhook ausgelöst wird. Der Status in der Liste zeigt Aktiviert oder Deaktiviert an. Ein deaktivierter Webhook zeichnet keine Zustellungen auf, wird aber nicht gelöscht, sodass Sie ihn später ohne Neukonfiguration wieder aktivieren können.
Webhook-Listen-Spalten
- Name: Webhook-Bezeichnung mit Erstellungsdatum.
- URL / E-Mail: die Zieladresse.
- Typ: API oder E-Mail.
- Ereignis: der Ereignisname (Sitzung erstellt, Bestellung erstellt oder Bestellung aktualisiert).
- Format: Json.
- Status: Aktiviert oder Deaktiviert.
Einen Webhook löschen
Wählen Sie einen oder mehrere Webhooks aus und klicken Sie auf Webhooks löschen. Dies ist dauerhaft und stoppt alle zukünftigen Zustellungen für dieses Abonnement.
Tipps und Fallstricke
- Sie können mehrere Webhooks für dasselbe Ereignis erstellen, zum Beispiel Bestellung erstellt sowohl an ein CRM als auch an eine Werbeplattform senden, jeweils als separaten Webhook-Eintrag.
- Wenn Ihr Endpunkt eine Authentifizierung erfordert, fügen Sie die Anmeldeinformationen über einen
{{Platzhalter}}aus den Ereignisdaten zur URL-Abfragezeichenfolge hinzu, oder richten Sie einen Proxy-Server ein, der die Authentifizierung übernimmt, bevor er an den eigentlichen Endpunkt weiterleitet. - Das Ereignis Sitzung erstellt wird für jede eindeutige Besuchersitzung ausgelöst, was bei beliebten Shops ein hohes Volumen erzeugen kann. Abonnieren Sie es nur, wenn Ihr Endpunkt den Durchsatz bewältigen kann.