Webhooks
- Cosa è un webhook?
- Come faccio a creare un webhook?
- Quali eventi attivano un webhook?
- Quali sono i parametri che un webhook invia?
Cosa è un webhook?
Con i Webhook è possibile inviare informazioni basate su eventi a un URL personalizzato. Quando si verifica un evento, ad esempio QR_CODE_SCANNED, l'URL indicato viene chiamato (webhook).
I webhook sono disponibili solo con il nostro piano White Label.
Come faccio a creare un webhook?
Una volta effettuato l'accesso come amministratore dalla White Label Platform, modificare un utente e andare alla sezione Webhooks. Qui è possibile impostare un URL di destinazione per ogni evento.
Quali eventi attivano un webhook?
Ci sono molti eventi diversi sulla piattaforma in cui un webhook può essere attivato.
| Evento | Innescato |
|---|---|
| QR_CODE_CREATED | quando è stato generato un codice QR |
| QR_CODE_SCANNED | quando un codice QR è stato scansionato |
| VOUCHER_CREATED | quando è stato creato un Voucher |
| VOUCHER_UPDATED | quando un Voucher è stato aggiornato |
| VOUCHER_REDEEMED | quando un buono è stato riscattato |
| VOUCHER_EXPIRED | quando un buono è scaduto |
| LEAD_CREATED | quando è stato creato un Lead |
| CALL_2_ACTION_BUTTON_CLICKED | quando è stato cliccato un pulsante Call-2-Action |
| JOB_FINISHED | quando il processo di creazione di codici QR in blocco è terminato |
Quali sono i parametri che un webhook invia?
Un URL webhook viene richiamato in base all'evento con determinati parametri che vengono avvolti in una richiesta POST.
Parametri standard
I seguenti parametri sono sempre inviati in un webhook.
| Parametri | Descrizione |
|---|---|
| event | Il nome dell'evento, ad esempio QR_CODE_SCANNED |
| timestamp | Il momento in cui si è verificato l'evento |
| user | L'utente che ha creato il codice QR |
| code | L'URL abbreviato dal codice QR |
| secrettoken | La chiave API segreta dell'API utente. È possibile utilizzare questa chiave per verificare che una richiesta webhook provenga dal proprio account. |
Il codice QR è stato scansionato
Questi parametri vengono inviati in aggiunta se è stato scansionato un codice QR.
| Parametri | Descrizione |
|---|---|
| accuracy | Precisione di scansione in metri. |
| anonymizedip | Indirizzo IP anonimizzato del dispositivo di scansione. |
| code | URL breve del codice QR. |
| country | Il Paese in cui è stato scansionato il codice QR. |
| device | Il dispositivo che ha scansionato il codice QR. |
| L'indirizzo e-mail del tuo account. | |
| event | QR_CODE_SCANNED |
| lng/lat | Informazioni opzionali sulla posizione con una coppia lng/lat se un utente invia i propri dati GPS. |
| mobile | Tipo di dispositivo scanner. |
| os | Il sistema operativo che ha scansionato il codice QR. |
| querystring | Quando i parametri URL di query vengono aggiunti all'URL breve di un codice QR, vengono aggiunti al payload. |
| redirects | Il numero di volte in cui è stato scansionato un codice QR. |
| secrettoken | La chiave API segreta del tuo account. |
| timestamp | La data e l'ora esatte in cui è stata eseguita la scansione. |
| type | QR Code/Landing Page type (URL = code QR dynamique, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING). |
| uniqueid | ID univoco di questa scansione specifica. |
| user | Il nome utente del tuo account. |
| visitors | Il numero di visitatori unici che hanno scansionato il codice QR. |
Il coupon è stato aggiornato
Questi parametri vengono inviati anche quando un voucher è stato aggiornato.
| Parametri | Descrizione |
|---|---|
| title | Il titolo del buono |
| description | La descrizione del buono |
| Il tipo di buono | |
| type | Il tipo di buono |
| UNIQUEIP - Il buono può essere riscattato una volta per IP. | |
| UNIQUEID - Il buono può essere riscattato una sola volta. | |
| productname | Nome opzionale del prodotto per il buono |
| website | Una pagina web opzionale a cui rimanda il voucher |
| couponnumber | Un numero voucher opzionale che verrà visualizzato sul voucher |
| validfrom | Una data facoltativa a partire dalla quale il buono è valido |
| validto | Una data facoltativa dalla quale il buono scade |
Il buono è stato riscattato
Questi parametri vengono inviati anche quando un voucher è stato riscattato.
| Parametri | Descrizione | |
|---|---|---|
| status | Stato del rimborso: | |
| SUCCESS | Il buono è stato riscattato | |
| VOUCHER_ALREADY_REDEEMED | Il buono era già stato riscattato in precedenza. | |
| VOUCHER_EXPIRED | Il buono è scaduto | |
| QUOTA_EXCEEDED | Il limite dei rimborsi è stato superato | |
| type | Tipo di buono: | |
| UNIQUEIP | Il buono può essere riscattato una volta per IP. | |
| UNIQUEID | Il buono può essere riscattato una sola volta. | |
| eancode | Se il voucher viene riscattato e viene impostato un codice a barre EAN, il codice EAN verrà trasmesso nel webhook. | |
| uniqueid | Se il codice QR è un buono utilizzabile una sola volta, viene restituito l'ID univoco del buono. Si tratta di uno degli ID univoci creati quando si generano codici QR in blocco per un buono utilizzabile una sola volta. |
Nuovo lead
Questi parametri vengono inviati anche quando viene generato un nuovo lead.
| Parametri | Descrizione |
|---|---|
| L'indirizzo e-mail del nuovo lead | |
| name | Il nome del nuovo protagonista |
Il pulsante C2A è stato cliccato
Questo parametro viene inviato anche quando viene cliccato un pulsante Call-2-Action.
| Parametri | Descrizione |
|---|---|
| c2a | L'URL del pulsante Call-2-Action |
Il lavoro è terminato
Questo parametro viene inviato anche quando un lavoro che fornisce codici QR di designer per il download viene completato con il calcolo.
| Parametri | Descrizione |
|---|---|
| download | Un link per scaricare il risultato del lavoro, valido per 30 giorni |
Debugging
Se si desidera visualizzare le informazioni inviate al server su un webhook, utilizzare il seguente script PHP per visualizzare tutti i parametri:
<?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'));Testare un webhook online
Con il servizio gratuito webhook.site potete testare immediatamente un webhook online.
Copiare una configurazione di webhook in un altro profilo utente
L'API Amministratore consente di copiare un'impostazione di webhook da un profilo utente a un altro.