Webhooks

3 Minuten

05.09.2022

Was ist ein Webhook?
Wie erstelle ich einen Webhook?
Bei welchen Ereignissen wird ein Webhook ausgelöst?
Welche Parameter schickt ein Webhook mit?
Debugging
Webhooks online testen
Webhooks auf anderes Benutzerprofil kopieren

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.

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
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 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
email	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.