Mit einem Webhook können Sie eine von Ihnen gewählte URL aufrufen, wenn ein bestimmtes Ereignis auftritt (zum Beispiel ein QR Code gescannt wird oder ein Gutschein eingelöst wird).
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 |
Eine Webhook URL wird je nach Ereignis mit bestimmten Parametern, die in einen POST Request verpackt werden, aufgerufen.
Standard Parameter | |||||||||
---|---|---|---|---|---|---|---|---|---|
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 scanned |
|||||||||
redirects |
Die Anzahl wie oft ein QR Code gescannt wurde | ||||||||
visitors |
Die Anzahl von eindeutigen Besuchern, die den QR Code gescannt haben | ||||||||
device |
Das Gerät, welches den QR Code gescannt hat | ||||||||
os |
Das Betriebssystem, welches den QR Code gescannt hat | ||||||||
country |
Das Land indem der QR Code gescannt wurde | ||||||||
lng/lat |
Eine optionale Ortsangabe mit einem lng/lat Paar, wenn ein Benutzer seine GPS Daten mitschickt. |
||||||||
Gutschein aktualisiert |
|||||||||
title |
Der Titel des Gutscheins | ||||||||
description |
Die Beschreibung des Gutscheins | ||||||||
type |
Der Gutscheintyp
|
||||||||
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 eingelöst |
|||||||||
status |
Status der Einlösung:
|
||||||||
type |
Der Gutscheintyp
|
||||||||
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. Siehe auch Gutschein API |
||||||||
Neuer Lead |
|||||||||
email |
Die E-Mail-Adresse des neuen Leads | ||||||||
name |
Der Name des neuen Leads |
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"); foreach ($_POST as $param_name => $param_val) { error_log("$param_name: $param_val"); }
Sie können Webhooks mit der Test-Instanz von unserem White Label QR Code Manager testen:
Test Webhooks