Mit Webhooks können Sie bestimmte Ereignisse in Fonzip an Ihre eigenen Server melden und die entsprechenden Ereignisse in Ihrem System speichern.
Was ist ein Webhook? Wie kann ich einen erstellen?
Webhooks sind eine Funktion, die Benachrichtigungen an eine gewünschte Adresse sendet, wenn ein Ereignis im System auftritt. Sie können einen Webhook erstellen, indem Sie im linken Menü zu Einstellungen > Erweitert > Webhooks navigieren und dort auf Webhook erstellen klicken.
Geben Sie auf dem Erstellungsbildschirm den Namen des Triggers und die Adresse ein, an die die Anfrage gesendet werden soll. Wählen Sie aus, welche Status Sie empfangen möchten, und speichern Sie.
Sie können den entsprechenden Webhook im Bereich "Aktionen" auf der rechten Seite testen.
Was ist der Inhalt eines Webhooks?
Wie unter https://fonzip.com/api/v2/docs#operation/createWebhook beschrieben, wird ein JSON an die von Ihnen für den Webhook angegebene URL gesendet.
{
"id": 0,
"webhook_id": 0,
"operation": 1,
"status": 0
}
id: Registrierungsnummer des entsprechenden Objekts
webhook_id: ID Ihres Webhooks
operation: Vorgangstyp ( 1: Spende, 2: Mitgliedsbeitrag, 3: Ticket, 4: Formular, 5: E-Card, 6: Spendenkampagne)
status: Vorgangsstatus (0: Kampagne erstellt, 3: erfolgreich, 4: Rückerstattung, 5: Fehler)
Eine Webhook-Anfrage ist eingegangen, was soll ich tun?
Nachdem die Webhook-Anfrage in Ihrem System eingegangen ist, können Sie sich mit der API verbinden und die Daten mit der Registrierungsnummer des entsprechenden Vorgangs in Ihr System ziehen.
Wenn beispielsweise eine Anfrage in Ihrem System eingeht, weil eine Spende getätigt wurde, können Sie die Spendendetails mit der Funktion Spendendetail abrufen ( https://fonzip.com/api/v2/docs#operation/getDonationDetails ) abrufen und in Ihrem System speichern.
Webhook wurde nicht empfangen / Wurde empfangen, aber es ist ein Fehler aufgetreten, was soll ich tun?
Fonzip versucht, einen Vorgang dreimal auszulösen. Wenn dies fehlschlägt, wird kein weiterer Versuch unternommen. Um möglichen Problemen vorzubeugen, können Sie einmal täglich die täglichen Vorgänge auflisten, die Gesamtzahl der Vorgänge mit Ihrem eigenen System vergleichen und fehlende Vorgänge aus der Liste abrufen.
Sie können beispielsweise den total-Parameter aus der Liste aller Spenden des Vortages, die Sie mit der Funktion Spenden auflisten ( https://fonzip.com/api/v2/docs#operation/getDonationList ) erhalten haben, mit Ihrem eigenen System vergleichen. Vergessen Sie nicht, bei diesen Anfragen nach Zeitzone abzufragen.