Webhooks
- Was ist ein Webhook?
- Wie erstelle ich einen Webhook?
- Bei welchen Ereignissen wird ein Webhook ausgelöst?
- Welche Parameter schickt ein Webhook mit?
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.
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.
| Event | ausgelöst wenn |
|---|---|
| QR_CODE_CREATED | ein QR Code angelegt wird |
| QR_CODE_SCANNED | ein QR Code gescannt wurde |
| VOUCHER_CREATED | ein Gutschein angelegt wurde |
| VOUCHER_UPDATED | ein Gutschein aktualisiert wurde |
| VOUCHER_REDEEMED | ein Gutschein eingelöst wurde |
| VOUCHER_EXPIRED | ein Gutschein abgelaufen ist |
| LEAD_CREATED | ein neuer Lead generiert wurde |
| CALL_2_ACTION_BUTTON_CLICKED | ein Call-2-Action Button wurde geklickt |
| JOB_FINISHED | ein 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.
| Parameter | Beschreibung |
|---|---|
| event | Der Name des Ereignisses z.B. QR_CODE_SCANNED |
| timestamp | Der Zeitpunkt, wann das Ereignis aufgetreten ist |
| user | Der Benutzer, der den QR Code angelegt hat |
| code | Die Kurz-URL von dem QR Code |
| secrettoken | Der 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.
| Parameter | Beschreibung |
|---|---|
| accuracy | Scan-Genauigkeit in Metern. |
| anonymizedip | Anonymisierte IP-Adresse des Scanners. |
| code | Die Short-URL des QR-Codes. |
| country | Das Land, in dem der QR-Code gescannt wurde. |
| device | Das Gerät, das den QR-Code gescannt hat. |
| Die E-Mail-Adresse Ihres Kontos. | |
| event | QR_CODE_SCANNED |
| lng/lat | Optionale Standortinformationen mit einem Längen-/Breitengradpaar, wenn GPS-Daten mitgeschickt werden. |
| mobile | Typ des Scanners. |
| os | Das Betriebssystem des Scanners. |
| querystring | Wenn Abfrage-URL-Parameter zur Short-URL eines QR-Codes hinzugefügt werden, werden sie zur Nutzlast hinzugefügt. |
| redirects | Gesamtzahl der Weiterleitungen dieses QR Codes. |
| secrettoken | Der geheime API-Schlüssel Ihres Kontos. |
| timestamp | Das genaue Datum und die Uhrzeit des Scans. |
| type | QR-Code/Landingpage-Typ (URL = dynamischer QR-Code, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL, TRACING). |
| uniqueid | Eindeutige ID dieses spezifischen Scans. |
| user | Der Benutzername Ihres Kontos. |
| visitors | Die Anzahl der einzelnen Besucher, die den QR-Code gescannt haben. |
Gutschein wurde aktualisiert
Diese Parameter werden zusätzlich mitgeschickt, wenn ein Gutschein aktualisiert wurde.
| Parameter | Beschreibung |
|---|---|
| title | Der Titel des Gutscheins |
| description | Die Beschreibung des Gutscheins |
| Der Gutscheintyp | |
| type | Der Gutscheintyp |
| UNIQUEIP Gutschein kann pro IP einmalig eingelöst werden | |
| UNIQUEID Gutschein kann einmalig eingelöst werden | |
| productname | Ein optionaler Produktname für den Gutschein |
| website | Eine optionale Webseite auf die der Gutschein verlinkt |
| couponnumber | Eine optionale Gutscheinnummer die auf dem Gutschein angezeigt wird |
| validfrom | Ein optionales Datum ab wann der Gutschein gültig ist |
| validto | Ein optionales Datum ab wann der Gutschein abgelaufen ist |
Gutschein wurde eingelöst
Diese Parameter werden zusätzlich mitgeschickt, wenn ein Gutschein eingelöst wurde.
| Parameter | Beschreibung | |
|---|---|---|
| status | Status der Einlösung: | |
| SUCCESS | Gutschein wurde eingelöst | |
| VOUCHER_ALREADY_REDEEMED | Gutschein wurde bereits zuvor eingelöst | |
| VOUCHER_EXPIRED | Gutschein ist abgelaufen | |
| QUOTA_EXCEEDED | Das Limit an Einlösungen wurde überschritten | |
| type | Der Gutscheintyp: | |
| UNIQUEIP | Gutschein kann pro IP einmalig eingelöst werden | |
| UNIQUEID | Gutschein kann einmalig eingelöst werden | |
| eancode | Wenn der Gutschein eingelöst wird und ein EAN-Barcode festgelegt wurde, wird der EAN-Code in der Webhook mitübermittelt. | |
| uniqueid | Wenn 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.
| Parameter | Beschreibung |
|---|---|
| Die E-Mail-Adresse des neuen Leads | |
| name | Der Name des neuen Leads |
C2A-Button wurde angeklickt
Dieser Parameter wird zusätzlich mitgeschickt, wenn ein Call-2-Action-Button angeklickt wurde.
| Parameter | Beschreibung |
|---|---|
| c2a | Die 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.
| Parameter | Beschreibung |
|---|---|
| download | Ein 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.