Este website usa apenas os cookies necessários para garantir que nosso website seja utilizado corretamente. Nós não utilizamos cookies que processam dados pessoais sem o seu consentimento prévio. Leia nosso política de cookies

Webhooks

book reader icon
3 Minutos
facebook logo gray
linkedin logo gray
mail logo gray
Webhooks

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.

EventTriggered
QR_CODE_CREATEDwhen a QR Code has been generated
QR_CODE_SCANNEDwhen a QR Code has been scanned
VOUCHER_CREATEDwhen a Voucher has been created
VOUCHER_UPDATEDwhen a Voucher has been updated
VOUCHER_REDEEMEDwhen a Voucher has been redeemed
VOUCHER_EXPIREDwhen a Voucher has been expired
LEAD_CREATEDwhen a Lead has been created
CALL_2_ACTION_BUTTON_CLICKEDwhen a Call-2-Action Button was clicked
JOB_FINISHEDwhen 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.

ParameterDescription
eventThe name of the event e.g. QR_CODE_SCANNED
timestampThe time when the event occurred
userThe user who created the QR Code
codeThe short URL from the QR Code
secrettokenThe 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.

ParameterDescription
redirectsThe number of times a QR Code was scanned
visitorsThe number of unique visitors who scanned the QR Code
deviceThe device that scanned the QR Code
osThe operating system that scanned the QR Code
countryThe country where the QR Code was scanned
lng/latAn 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.

ParameterDescription
titleThe title of the voucher
descriptionThe description of the voucher
The type of voucher
typeThe type of voucher
UNIQUEIP                  Voucher can be redeemed once per IP
UNIQUEID                   Voucher can be redeemed once
productnameAn optional product name for the voucher
websiteAn optional web page to which the voucher links
couponnumberAn optional voucher number that will be displayed on the voucher
validfromAn optional date from when the voucher is valid
validtoAn optional date from when the voucher expires

Voucher foi resgatado

Estes parâmetros são enviados adicionalmente quando um voucher foi resgatado.

ParameterDescription
statusStatus of redemption:
SUCCESSVoucher was redeemed
VOUCHER_ALREADY_REDEEMEDVoucher was already redeemed before
VOUCHER_EXPIREDVoucher has expired
QUOTA_EXCEEDEDThe limit of redemptions was exceeded
typeThe voucher type:
UNIQUEIPVoucher can be redeemed once per IP
UNIQUEIDVoucher can be redeemed once
eancodeIf the voucher is redeemed and an EAN barcode is set, the EAN code will be transmitted in the webhook.
uniqueidIf 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.

ParameterDescription
emailThe email address of the new lead
nameThe name of the new lead

C2A-botão foi clicado

Este parâmetro também é enviado quando um Call-2-Action button é clicado.

ParameterDescription
c2aThe 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.

ParameterDescription
downloadA 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.

Última atualização faz 3 semanas