Diese Website verwendet erforderliche Cookies, um sicherzustellen, dass unsere Website optimal genutzt werden kann. Wir verwenden keine Cookies, die personenbezogene Daten ohne Ihre vorherige Zustimmung verarbeiten. Cookie Richtlinien Ok

3 Minuten
share fb

Webhooks

Webhooks

Was ist ein Webhook?

Mit einem Webhook können Sie eine von Ihnen gewählte URL aufrufen, wenn ein bestimmtes Ereignis auftritt. Ein Ereignis ist zum Beispiel ein QR Code wird gescannt oder ein Gutschein wurde eingelöst.

Webhooks werden nur in unserem White Label Paket unterstützt.

Wie erstelle ich einen Webhook?

Wenn Sie als Administrator von der White Label Plattform eingeloggt sind, bearbeiten Sie einen Benutzer und wechseln in den Abschnitt Webhooks. Dort können Sie für jedes Ereignis eine Ziel-URL festlegen.

Bei welchen Ereignissen wird ein Webhook ausgelöst?

Es gibt auf der Plattform viele unterschiedliche Ereignisse bei denen ein Webhook ausgelöst werden kann.

Eventausgelöst wenn
QR_CODE_CREATEDein QR Code angelegt wird
QR_CODE_SCANNEDein QR Code gescannt wurde
VOUCHER_CREATEDein Gutschein angelegt wurde
VOUCHER_UPDATEDein Gutschein aktualisiert wurde
VOUCHER_REDEEMEDein Gutschein eingelöst wurde
VOUCHER_EXPIREDein Gutschein abgelaufen ist
LEAD_CREATEDein neuer Lead generiert wurde
CALL_2_ACTION_BUTTON_CLICKEDein Call-2-Action Button wurde geklickt
JOB_FINISHEDein Job wurde beendet

Welche Parameter schickt ein Webhook mit?

Eine Webhook URL wird je nach Ereignis mit bestimmten Parametern, die in einen POST Request verpackt werden, aufgerufen.

Standard Parameter

Die folgenden Parameter werden immer in einem Webhook mitgeschickt.

ParameterBeschreibung
eventDer Name des Ereignisses z.B. QR_CODE_SCANNED
timestampDer Zeitpunkt, wann das Ereignis aufgetreten ist
userDer Benutzer, der den QR Code angelegt hat
codeDie Kurz-URL von dem QR Code
secrettokenDer geheime API-Schlüssel aus der Benutzer-API. Mit diesem Schlüssel können Sie eine Webhook-Anfrage überprüfen, ob diese von Ihrem Konto stammt.

QR Code wurde gescannt

Diese Parameter werden zusätzlich mitgeschickt, wenn ein QR Code gescannt wurde.

ParameterBeschreibung
redirectsDie Anzahl wie oft ein QR Code gescannt wurde
visitorsDie Anzahl von eindeutigen Besuchern, die den QR Code gescannt haben
deviceDas Gerät, welches den QR Code gescannt hat
osDas Betriebssystem, welches den QR Code gescannt hat
countryDas Land indem der QR Code gescannt wurde
lng/latEine optionale Ortsangabe mit einem lng/lat Paar, wenn ein Benutzer seine GPS Daten mitschickt.

Gutschein wurde aktualisiert

Diese Parameter werden zusätzlich mitgeschickt, wenn ein Gutschein aktualisiert wurde.

ParameterBeschreibung
titleDer Titel des Gutscheins
descriptionDie Beschreibung des Gutscheins
Der Gutscheintyp
typeDer Gutscheintyp
UNIQUEIP                 Gutschein kann pro IP einmalig eingelöst werden
UNIQUEID                 Gutschein kann einmalig eingelöst werden
productnameEin optionaler Produktname für den Gutschein
websiteEine optionale Webseite auf die der Gutschein verlinkt
couponnumberEine optionale Gutscheinnummer die auf dem Gutschein angezeigt wird
validfromEin optionales Datum ab wann der Gutschein gültig ist
validtoEin optionales Datum ab wann der Gutschein abgelaufen ist

Gutschein wurde eingelöst

Diese Parameter werden zusätzlich mitgeschickt, wenn ein Gutschein eingelöst wurde.

ParameterBeschreibung
statusStatus der Einlösung:
SUCCESSGutschein wurde eingelöst
ALREADY_REDEEMEDGutschein wurde bereits zuvor eingelöst
VOUCHER_EXPIREDGutschein ist abgelaufen
QUOTA_EXCEEDEDDas Limit an Einlösungen wurde überschritten
typeDer Gutscheintyp:
UNIQUEIPGutschein kann pro IP einmalig eingelöst werden
UNIQUEIDGutschein kann einmalig eingelöst werden
eancodeWenn der Gutschein eingelöst wird und ein EAN-Barcode festgelegt wurde, wird der EAN-Code in der Webhook mitübermittelt.
uniqueidWenn der QR Code ein einmalig einlösbarer Gutschein ist, wird die eindeutige ID des Gutscheins zurückgegeben. Dies ist eine der eindeutigen IDs, wenn Sie Massen QR Codes für einen eindeutig einlösbaren Gutschein erstellen.

Neuer Lead

Diese Parameter werden zusätzlich mitgeschickt, wenn ein neuer Lead generiert wurde.

ParameterBeschreibung
emailDie E-Mail-Adresse des neuen Leads
nameDer Name des neuen Leads

C2A-Button wurde angeklickt

Dieser Parameter wird zusätzlich mitgeschickt, wenn ein Call-2-Action-Button angeklickt wurde.

ParameterBeschreibung
c2aDie URL von dem Call-2-Action Button Lorem

Job wurde beendet

Dieser Parameter wird zusätzlich mitgeschickt, wenn ein Job, der Designer QR Codes zum Download bereitstellt, mit der Berechnung fertig ist.

ParameterBeschreibung
downloadEin Link zum Download für das Jobergebnis der 30 Tage gültig ist

Debugging

Wenn Sie die Informationen, die an Ihren Server bei einem Webhook geschickt werden, ausgeben möchten, verwenden Sie folgendes PHP Skript um alle Parameter anzuzeigen:

<?php

    // Test WebHook und zeige übergebene Parameter an

    error_log("Fired WebHook");

    // Post Parameter anzeigen
    foreach ($_POST as $param_name => $param_val) {
        error_log("$param_name: $param_val");
    }
    
    // Get Parameter anzeigen
    foreach ($_GET as $param_name => $param_val) {
        error_log("$param_name: $param_val");
    }
    
    // falls ein JSON übermittelt wird
    $json = json_decode(file_get_contents('php://input'));

Webhooks online testen

Mit dem kostenlosen Service webhook.site können Sie die Webhooks sofort online testen.

Webhooks auf anderes Benutzerprofil kopieren

Mit der Administrator API können Sie die Webhooks von einem Benutzerprofil zu einem anderen kopieren.

Letzte Aktualisierung vor 2 Wochen
Top