Webhooks
- O que é um webhook?
- Como eu crio um webhook?
- Que eventos acionam um webhook?
- Que parâmetros é que um gancho da web envia junto?
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).
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.
| Evento | Acionado |
|---|---|
| QR_CODE_CREATED | quando um código QR foi gerado |
| QR_CODE_SCANNED | quando um código QR é lido |
| VOUCHER_CREATED | quando um voucher foi criado |
| VOUCHER_UPDATED | quando um voucher foi atualizado |
| VOUCHER_REDEEMED | quando um voucher foi resgatado |
| VOUCHER_EXPIRED | quando um voucher expirou |
| LEAD_CREATED | quando um Lead foi criado |
| CALL_2_ACTION_BUTTON_CLICKED | quando um botão Call-2-Action foi clicado |
| JOB_FINISHED | quando um processo de QR Code para designers em massa é concluído |
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.
| Parâmetros | Descrição |
|---|---|
| event | O nome do evento, por exemplo, QR_CODE_SCANNED |
| timestamp | A hora em que o evento ocorreu |
| user | O utilizador que criou o QR Code |
| code | A URL curta do código QR |
| secrettoken | A chave API secreta da API do utilizador. Pode usar esta chave para verificar se uma solicitação de webhook é proveniente da sua conta. |
Código QR foi escaneado
Estes parâmetros são enviados adicionalmente se um QR Code foi escaneado.
| Parâmetros | Descrição |
|---|---|
| accuracy | Precisão da digitalização em metros. |
| anonymizedip | Endereço IP anónimo do dispositivo de digitalização. |
| code | URL curta do QR Code. |
| country | O país onde o QR Code foi digitalizado. |
| device | O dispositivo que leu o código QR. |
| O endereço de e-mail da sua conta. | |
| event | QR_CODE_SCANNED |
| lng/lat | Uma informação de localização opcional com um par lng/lat, caso o utilizador envie os seus dados GPS. |
| mobile | Tipo de dispositivo scanner. |
| os | O sistema operativo que leu o código QR. |
| querystring | Quando os parâmetros de URL de consulta são adicionados à URL curta de um código QR, eles são adicionados à carga útil. |
| redirects | O número de vezes que um código QR foi digitalizado. |
| secrettoken | A chave API secreta da sua conta. |
| timestamp | A data e hora exatas em que a verificação ocorreu. |
| type | Tipo de código QR/página de destino (URL = code QR dynamique, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING). |
| uniqueid | ID exclusivo desta verificação específica. |
| user | O nome de utilizador da sua conta. |
| visitors | O número de visitantes únicos que escanearam o código QR. |
Coupon foi atualizado
Estes parâmetros são adicionalmente enviados quando um voucher é atualizado.
| Parâmetros | Descrição |
|---|---|
| title | O título do voucher |
| description | A descrição do voucher |
| O tipo de voucher | |
| type | O tipo de voucher |
| UNIQUEIP - O voucher pode ser resgatado uma vez por IP. | |
| UNIQUEID - O voucher pode ser resgatado uma vez | |
| productname | Um nome opcional para o produto do voucher |
| website | Uma página web opcional para a qual o voucher direciona |
| couponnumber | Um número de voucher opcional que será exibido no voucher |
| validfrom | Uma data opcional a partir da qual o voucher é válido |
| validto | Uma data opcional a partir da qual o voucher expira |
Voucher foi resgatado
Estes parâmetros são enviados adicionalmente quando um voucher foi resgatado.
| Parâmetros | Descrição | |
|---|---|---|
| status | Estado do resgate: | |
| SUCCESS | O voucher foi resgatado | |
| VOUCHER_ALREADY_REDEEMED | O voucher já foi resgatado anteriormente. | |
| VOUCHER_EXPIRED | O voucher expirou | |
| QUOTA_EXCEEDED | O limite de resgates foi excedido | |
| type | O tipo de voucher: | |
| UNIQUEIP | O voucher pode ser resgatado uma vez por IP. | |
| UNIQUEID | O voucher pode ser resgatado uma vez | |
| eancode | Se o voucher for resgatado e um código de barras EAN estiver definido, o código EAN será transmitido no webhook. | |
| uniqueid | Se o QR Code for um voucher resgatável uma única vez, o ID exclusivo do voucher será retornado. Esse é um dos IDs exclusivos quando você cria QR Codes em massa para um voucher resgatável exclusivamente. |
Novo chumbo
Estes parâmetros são enviados adicionalmente quando uma nova pista é gerada.
| Parâmetros | Descrição |
|---|---|
| O endereço de e-mail do novo lead | |
| name | O nome do novo líder |
C2A-botão foi clicado
Este parâmetro também é enviado quando um Call-2-Action button é clicado.
| Parâmetros | Descrição |
|---|---|
| c2a | A URL do botão Call-2-Action 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.
| Parâmetros | Descrição |
|---|---|
| download | Um link para descarregar o resultado do trabalho, válido por 30 dias |
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.