
Webhooks in der FoodSoul-API: Das CRM informiert Ihre Dienste selbstständig über neue Ereignisse
Jetzt sendet FoodSoul selbst Benachrichtigungen an Ihre Systeme, sobald in der CRM etwas passiert. Zum Beispiel, wenn eine neue Bestellung eingeht, ein Kunde bezahlt oder Geld zurückerstattet wird, oder ein neuer Gast sich registriert. Es reicht, einmal die Adresse Ihres Dienstes anzugeben, und die Daten werden sofort an Ihr Buchhaltungssystem, Ihren Bot, ein weiteres CRM oder Ihre Analytik weitergeleitet.
Über welche Ereignisse können Benachrichtigungen empfangen werden
- Neue Bestellung mit vollständiger Karte. Nützlich für das Buchhaltungssystem, die Küche und die Analytik.
- Statusänderung der Bestellung. Geeignet für einen Bot, der den Kunden über die Bestellung informiert, und für das Callcenter.
- Statusänderung der Zahlung, einschließlich Rückerstattung. Wird für die Buchhaltung und das Finanzwesen benötigt.
- Neuer Kunde und Änderung seiner Daten. Für externe CRM und Newsletter-Services.
- Gutschrift, Abbuchung und Verfall von Bonuspunkten. Für das Treueprogramm und die Kommunikation mit Gästen.
- Neue Bewertung. Für den Manager und den Qualitätsservice.
- Zuweisung eines Kuriers. Für die Logistik und Benachrichtigungen an den Kunden.
- Änderung der Stoppliste. Für die Website, die Küche und die Plattformen, auf denen Sie verkaufen.
- Filiale hat die Annahme von Bestellungen gestoppt oder wieder aufgenommen. Für die operative Kontrolle und die Geschäftsleitung des Netzwerks.
Sie wählen selbst aus, über welche Ereignisse Sie Benachrichtigungen erhalten möchten. Sie können nur die benötigten anschließen, zum Beispiel „neue Bestellung“ und „Zahlung“. Haben Sie das gewünschte Ereignis nicht gefunden? Schreiben Sie uns – wir fügen es gerne hinzu.
Wie man anschließt
- Aktivieren Sie Webhooks für die gewünschte Filiale – der Signaturschlüssel wird automatisch erstellt.
- Wählen Sie die Ereignisse aus, über die Sie Benachrichtigungen erhalten möchten.
- Geben Sie die Adresse Ihres Dienstes an, an die FoodSoul die Daten senden wird. Es wird nur eine Adresse mit HTTPS akzeptiert.
- Fügen Sie den Signaturschlüssel in den Dienst ein, der die Benachrichtigungen empfängt, und richten Sie die Signaturprüfung ein. Wenn Sie beim Erstellen der Webhooks verschiedene Adressen angegeben haben, fügen Sie den Schlüssel in jeden Dienst ein.
- Stellen Sie sicher, dass Ihr Dienst den Empfang der Benachrichtigung innerhalb von 10 Sekunden bestätigt, sonst sendet FoodSoul sie erneut.
Richten Sie eine Prüfung auf Wiederholungen ein: dieselbe Benachrichtigung kann mehrmals eintreffen. Alle Wiederholungen haben die gleiche ID (Header X-Webhook-ID). Ihr Dienst sollte die IDs der verarbeiteten Benachrichtigungen speichern und Wiederholungen überspringen – so wird eine Zahlung nicht doppelt durchgeführt.
Sicherheit: Wozu dient der Signaturschlüssel
FoodSoul signiert jede Benachrichtigung mit einem Signaturschlüssel – einer Zeichenfolge, die nur Sie und wir besitzen. Anhand dieser Signatur prüft Ihr System, dass die Benachrichtigung tatsächlich von FoodSoul stammt und unterwegs nicht verändert wurde.
Jeder kann eine Anfrage an die Adresse Ihres Dienstes senden. Zum Beispiel könnte ein Betrüger eine gefälschte Benachrichtigung „Bestellung bezahlt“ schicken, und Sie würden eine unbezahlte Bestellung ausliefern.
Mit der Signatur ist das nicht möglich. Ihr Server berechnet die Signatur mit demselben Schlüssel und vergleicht sie mit der empfangenen. Stimmen die Signaturen nicht überein, ist die Benachrichtigung gefälscht oder verändert.
Wenn etwas schiefgeht
- Wenn Ihr Dienst vorübergehend nicht erreichbar ist, versucht FoodSoul noch mehrere Male, die Benachrichtigung innerhalb von 10 Stunden zuzustellen. Ein kurzer Ausfall oder Neustart des Servers führt nicht zum Verlust von Ereignissen.
- Wenn das Problem länger andauert, wird das Abonnement deaktiviert und Sie erhalten eine E-Mail – so erfahren Sie von dem Problem.
- Um das Abonnement wieder zu aktivieren, wenden Sie sich an den Support. Dort können auch Benachrichtigungen erneut gesendet werden, die während der Störung nicht zugestellt wurden.
Eine ausführliche Beschreibung der Ereignisse und des Datenformats finden Sie in der API-Dokumentation.
Mit freundlichen Grüßen, Ihr FoodSoul-Team! Wir arbeiten für Sie!