O que é um webhook?
Com o Webhooks você pode enviar informações baseadas em eventos para uma URL personalizada. Quando um evento, por exemplo, QR_CODE_SCANNED ocorre, sua URL determinada será chamada (webhooked).
Gancho web só estão disponíveis com nosso Plano de etiqueta branca.
Como eu crio um webhook?
Quando estiver logado como administrador da Plataforma White Label, edite um usuário e vá para a seção Webhooks. Lá você pode definir uma URL de destino para cada evento.
Que eventos acionam um webhook?
Existem muitos eventos diferentes na plataforma onde um gancho da web pode ser acionado.
| 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 |
Que parâmetros é que um gancho da web envia junto?
Um webhook URL é chamado dependendo do evento com certos parâmetros que são envolvidos em um pedido POST.
Parâmetros padrão
Os seguintes parâmetros são sempre enviados em um 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. |
Código QR foi escaneado
Estes parâmetros são enviados adicionalmente se um QR Code foi escaneado.
| 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. |
Coupon foi atualizado
Estes parâmetros são adicionalmente enviados quando um voucher é atualizado.
| 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 |
Voucher foi resgatado
| 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. |
Novo chumbo
Estes parâmetros são enviados adicionalmente quando uma nova pista é gerada.
| Parameter | Description |
|---|
| email | The email address of the new lead |
| name | The name of the new lead |
C2A-botão foi clicado
| Parameter | Description |
|---|
| c2a | The URL of the Call-2-Action button Lorem |
Emprego foi terminado
Este parâmetro é enviado adicionalmente quando um trabalho que fornece os Códigos QR do designer para download é terminado com o cálculo.
| Parameter | Description |
|---|
| download | A link to download the job result that is valid for 30 days |
Debugging
Se você deseja produzir as informações enviadas ao seu servidor em um webhook, use o seguinte script PHP para exibir todos os parâmetros:
<?php
// Testar WebHook e mostrar parâmetros
error_log("Fired WebHook");
// Parâmetro Post
foreach ($_POST como $param_name => $param_val) {
error_log("$param_name: $param_val");
}
// Obter Parâmetro
foreach ($_GET como $param_name => $param_val) {
error_log("$param_name: $param_val");
}
// se o JSON apresentou
$json = json_decode(file_get_contents('php://input')));Teste um webhook online
Com o serviço gratuito webhook.site serviço você pode testar imediatamente um webhook online.
Copiar a configuração de um gancho para outro perfil de usuário
A API do Administrador permite que você copie a configuração de um webhook de um perfil de usuário para outro.