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.
| Event | Triggered |
|---|
| QR_CODE_CREATED | when a QR Code has been generated |
| QR_CODE_SCANNED | when a QR Code has been scanned |
| VOUCHER_CREATED | when a Voucher has been created |
| VOUCHER_UPDATED | when a Voucher has been updated |
| VOUCHER_REDEEMED | when a Voucher has been redeemed |
| VOUCHER_EXPIRED | when a Voucher has been expired |
| LEAD_CREATED | when a Lead has been created |
| CALL_2_ACTION_BUTTON_CLICKED | when a Call-2-Action Button was clicked |
| JOB_FINISHED | when a bulk designer QR Code process is finished |
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.
| Parameter | Description |
|---|
| event | The name of the event e.g. QR_CODE_SCANNED |
| timestamp | The time when the event occurred |
| user | The user who created the QR Code |
| code | The short URL from the QR Code |
| secrettoken | The secret API key from the user API. You can use this key to verify a webhook request is from your account. |
Il codice QR è stato scansionato
Questi parametri vengono inviati in aggiunta se è stato scansionato un codice QR.
| Parameter | Description |
|---|
| redirects | The number of times a QR Code was scanned |
| visitors | The number of unique visitors who scanned the QR Code |
| device | The device that scanned the QR Code |
| os | The operating system that scanned the QR Code |
| country | The country where the QR Code was scanned |
| lng/lat | An optional location information with a lng/lat pair if a user sends along his GPS data. |
Il coupon è stato aggiornato
Questi parametri vengono inviati anche quando un voucher è stato aggiornato.
| Parameter | Description |
|---|
| title | The title of the voucher |
| description | The description of the voucher |
| The type of voucher |
| type | The type of voucher |
| UNIQUEIP Voucher can be redeemed once per IP |
| UNIQUEID Voucher can be redeemed once |
| productname | An optional product name for the voucher |
| website | An optional web page to which the voucher links |
| couponnumber | An optional voucher number that will be displayed on the voucher |
| validfrom | An optional date from when the voucher is valid |
| validto | An optional date from when the voucher expires |
Il buono è stato riscattato
| Parameter | Description | |
|---|
| status | Status of redemption: | |
| SUCCESS | Voucher was redeemed |
| VOUCHER_ALREADY_REDEEMED | Voucher was already redeemed before |
| VOUCHER_EXPIRED | Voucher has expired |
| QUOTA_EXCEEDED | The limit of redemptions was exceeded |
| type | The voucher type: | |
| UNIQUEIP | Voucher can be redeemed once per IP |
| UNIQUEID | Voucher can be redeemed once |
| eancode | | If the voucher is redeemed and an EAN barcode is set, the EAN code will be transmitted in the webhook. |
| uniqueid | | If the QR Code is a one-time redeemable voucher, the unique ID of the voucher is returned. This is one of the unique IDs when you create bulk QR Codes for a uniquely redeemable voucher. |
Nuovo lead
| Parameter | Description |
|---|
| email | The email address of the new lead |
| name | The name of the new lead |
Il pulsante C2A è stato cliccato
| Parameter | Description |
|---|
| c2a | The URL of the Call-2-Action button Lorem |
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.
| Parameter | Description |
|---|
| download | A link to download the job result that is valid for 30 days |
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.