Co to jest webhook?
Dzięki Webhooks możesz wysyłać informacje oparte na zdarzeniach do niestandardowego adresu URL. Gdy wystąpi zdarzenie, np. QR_CODE_SCANNED, dany adres URL zostanie wywołany (webhooked).
Jak utworzyć webhook?
Po zalogowaniu się jako administrator na platformie White Label, edytuj użytkownika i przejdź do sekcji Webhooks. Tam możesz ustawić docelowy adres URL dla każdego zdarzenia.
Jakie zdarzenia wyzwalają webhook?
Istnieje wiele różnych zdarzeń na platformie, w których można uruchomić webhook.
| Wydarzenie | Wyzwolony |
|---|
| QR_CODE_CREATED | gdy kod QR został wygenerowany |
| QR_CODE_SCANNED | gdy kod QR został zeskanowany |
| VOUCHER_CREATED | gdy kupon został utworzony |
| VOUCHER_UPDATED | gdy kupon został zaktualizowany |
| VOUCHER_REDEEMED | gdy kupon został zrealizowany |
| VOUCHER_EXPIRED | gdy kupon stracił ważność |
| LEAD_CREATED | gdy został utworzony potencjalny klient |
| CALL_2_ACTION_BUTTON_CLICKED | po kliknięciu przycisku Call-2-Action |
| JOB_FINISHED | po zakończeniu procesu projektowania kodu QR dla dużych zbiorów danych |
Jakie parametry wysyła webhook?
Adres URL webhooka jest wywoływany w zależności od zdarzenia z określonymi parametrami, które są opakowane w żądanie POST.
Standardowe parametry
Następujące parametry są zawsze wysyłane wraz z webhookiem.
| Parametry | Opis |
|---|
| event | Nazwa wydarzenia, np. QR_CODE_SCANNED |
| timestamp | Czas, w którym miało miejsce zdarzenie |
| user | Użytkownik, który utworzył kod QR |
| code | Skrócony adres URL z kodu QR |
| secrettoken | Tajny klucz API z interfejsu API użytkownika. Możesz użyć tego klucza do weryfikacji, czy żądanie webhook pochodzi z Twojego konta. |
Kod QR został zeskanowany
Parametry te są dodatkowo wysyłane, jeśli zeskanowany został kod QR.
| Parametry | Opis |
|---|
| redirects | Liczba skanowań kodu QR |
| visitors | Liczba unikalnych użytkowników, którzy zeskanowali kod QR |
| device | Urządzenie, które zeskanowało kod QR |
| os | System operacyjny, który zeskanował kod QR |
| country | Kraj, w którym zeskanowano kod QR |
| lng/lat | Opcjonalna informacja o lokalizacji zawierająca parę współrzędnych szerokości i długości geograficznej, jeśli użytkownik przesyła swoje dane GPS. |
|
|
| Parametry | Opis |
|---|
| accuracy | Dokładność skanowania w metrach. |
| anonymizedip | Anonimizowany adres IP urządzenia skanującego. |
| code | Skrócony adres URL kodu QR. |
| country | Kraj, w którym zeskanowano kod QR. |
| device | Urządzenie, które zeskanowało kod QR. |
| email | Adres e-mail Twojego konta. |
| event | QR_CODE_SCANNED |
| lng/lat | Opcjonalna informacja o lokalizacji zawierająca parę współrzędnych szerokości i długości geograficznej, jeśli użytkownik przesyła swoje dane GPS. |
| mobile | Scanner device type. |
| os | Gdy parametry zapytania URL są dodawane do skróconego adresu URL kodu QR, są one dodawane do ładunku. |
| querystring | Gdy parametry zapytania URL są dodawane do skróconego adresu URL kodu QR, są one dodawane do ładunku. |
| redirects | Liczba skanowań kodu QR. |
| secrettoken | Tajny klucz API Twojego konta. |
| timestamp | Dokładna data i godzina wykonania skanowania. |
| type | Kod QR/typ strony docelowej (URL = code QR dynamique, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING). |
| uniqueid | Unikalny identyfikator tego konkretnego skanowania. |
| user | Nazwa użytkownika Twojego konta. |
| visitors | Liczba unikalnych użytkowników, którzy zeskanowali kod QR. |
Kod QR został zaktualizowany
Parametry te są dodatkowo wysyłane, jeśli docelowy adres URL kodu QR zostanie zaktualizowany.
| Parametry | Opis |
|---|
| url | Nowy docelowy adres URL zaktualizowanego kodu QR |
uniqevisitors
| Unikalni użytkownicy
|
redirect
| Liczba przekierowań
|
title
| Tytuł kodu QR
|
description
| Pole opisu kodu QR
|
Type
| URL, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING
|
Subtype
| URL, FACEBOOK_PAGE, FACEBOOK_LIKE, INSTAGRAM, SKYPE, APPSTORE, YOUTUBE, TWITTER, LINKEDIN, SMS, EMAIL, TEXT, VCARD, WLAN, GEO, PAYPAL, PINTEREST, EVENT, PHONE, SEPA, MULTI, BITCOIN, VOUCHER, WHATSAPP, PDF, MULTI_LANGUAGE, MP3, MULTI_GEO, MULTI_GEO_CLOSEST, UNLIMITED, UNIQUEIP, UNIQUEID, ONE, GS1
|
| Creation date | Data utworzenia kodu QR |
Kupon został zaktualizowany
Parametry te są dodatkowo wysyłane, gdy voucher został zaktualizowany.
| Parametry | Opis |
|---|
| title | Tytuł kuponu |
| description | Opis kuponu |
| Rodzaj kuponu |
| type | Rodzaj kuponu |
| UNIQUEIP - Kupon można zrealizować raz na adres IP. |
| UNIQUEID - Kupon można zrealizować jednokrotnie. |
| productname | Opcjonalna nazwa produktu dla kuponu |
| website | Opcjonalna strona internetowa, do której prowadzi link z kuponu |
| couponnumber | Opcjonalny numer kuponu, który zostanie wyświetlony na kuponie |
| validfrom | Opcjonalna data ważności kuponu |
| validto | Opcjonalna data wygaśnięcia kuponu |
Voucher został zrealizowany
| Parametry | Opis | |
|---|
| status | Status wykupu: | |
| SUCCESS | Kupon został zrealizowany |
| VOUCHER_ALREADY_REDEEMED | Kupon został już zrealizowany wcześniej. |
| VOUCHER_EXPIRED | Kupon stracił ważność |
| QUOTA_EXCEEDED | Limit wykupów został przekroczony. |
| type | Rodzaj kuponu: | |
| UNIQUEIP | Kupon można zrealizować raz na adres IP. |
| UNIQUEID | Kupon można zrealizować jednokrotnie. |
| eancode | | Jeśli kupon zostanie zrealizowany i ustawiony zostanie kod kreskowy EAN, kod EAN zostanie przesłany w webhooku. |
| uniqueid | | Jeśli kod QR jest kuponem jednorazowym, zwracany jest unikalny identyfikator kuponu. Jest to jeden z unikalnych identyfikatorów tworzonych podczas generowania zbiorczych kodów QR dla kuponów jednorazowych. |
Nowy lead
| Parametry | Opis |
|---|
| email | Adres e-mail nowego potencjalnego klienta |
| name | Nazwa nowego potencjalnego klienta |
Przycisk C2A został kliknięty
Parametr ten jest również wysyłany po kliknięciu przycisku Call-2-Action
| Parametry | Opis |
|---|
| c2a | Adres URL przycisku Call-2-Action |
Praca została zakończona
Parametr ten jest dodatkowo wysyłany, gdy zadanie dostarczające projektantowi kody QR do pobrania zakończy obliczenia.
| Parametry | Opis |
|---|
| download | Link do pobrania wyników zadania, ważny przez 30 dni |
Dzienniki webhooków
Możesz sprawdzić logi w ustawieniach użytkownika, aby zobaczyć, które webhooki, kiedy zostały uruchomione i czy wystąpił jakiś błąd.
Debugowanie
Jeśli chcesz wyświetlić informacje wysłane do serwera za pomocą webhooka, użyj następującego skryptu PHP, aby wyświetlić wszystkie parametry:
<?php
// Test WebHook and show parameters
error_log("Fired WebHook");
// Post Parameter
foreach ($_POST as $param_name => $param_val) {
error_log("$param_name: $param_val");
}
// Get Parameter
foreach ($_GET as $param_name => $param_val) {
error_log("$param_name: $param_val");
}
// if JSON submitted
$json = json_decode(file_get_contents('php://input'));Testuj webhook online
Dzięki bezpłatnej usłudze webhook.site możesz natychmiast przetestować webhook online.
Kopiowanie konfiguracji webhook do innego profilu użytkownika
API Administratora umożliwia kopiowanie konfiguracji webhooków z jednego profilu użytkownika do drugiego.