Qu'est-ce qu'un webhook?
Avec les Webhooks, vous pouvez envoyer des informations basées sur des événements à une URL personnalisée. Lorsqu'un événement, par exemple QR_CODE_SCANNED, se produit, l'URL que vous avez indiquée est appelée (webhooked).
-Les webhooks ne sont disponibles qu'avec notre plan White Label plan.
Dans le cadre d'un plan de gestion des codes, il est possible de mettre en place un système de gestion des codes
Quels sont les événements qui déclenchent un webhook?
Il existe de nombreux événements différents sur la plateforme où un webhook peut être déclenché
| Événement | Actionné |
|---|
| QR_CODE_CREATED | lorsqu'un code QR a été généré |
| QR_CODE_SCANNED | lorsqu'un code QR a été scanné |
| VOUCHER_CREATED | lorsqu'un bon a été créé |
| VOUCHER_UPDATED | lorsqu'un bon a été mis à jour |
| VOUCHER_REDEEMED | lorsqu'un bon a été utilisé |
| VOUCHER_EXPIRED | lorsqu'un bon a expiré |
| LEAD_CREATED | lorsqu'un prospect a été créé |
| CALL_2_ACTION_BUTTON_CLICKED | lorsqu'un bouton d'appel à l'action a été cliqué |
| JOB_FINISHED | lorsqu'un processus de conception de QR Code en masse est terminé |
Quels sont les paramètres envoyés par un webhook?
Une URL webhook est appelée en fonction de l'événement avec certains paramètres qui sont enveloppés dans une requête POST
Paramètres standard
Les paramètres suivants sont toujours envoyés dans un webhook
| Paramètres | Description |
|---|
| event | Le nom de l'événement, par exemple QR_CODE_SCANNED |
| timestamp | Le moment où l'événement s'est produit |
| user | L'utilisateur qui a créé le code QR |
| code | L'URL courte du code QR |
| secrettoken | La clé API secrète de l'API utilisateur. Vous pouvez utiliser cette clé pour vérifier qu'une requête webhook provient bien de votre compte. |
Le code QR a été scanné
Ces paramètres sont également envoyés si un code QR a été scanné.
| Paramètres | Description |
|---|
| redirects | Le nombre de fois où un code QR a été scanné |
| visitors | Nombre de visiteurs uniques ayant scanné le code QR |
| device | L'appareil qui a scanné le code QR |
| os | Le système d'exploitation qui a scanné le code QR |
| country | Le pays où le code QR a été scanné |
| lng/lat | Une information de localisation facultative avec une paire lng/lat si un utilisateur envoie ses données GPS. |
| querystring | Lorsque des paramètres URL de requête sont ajoutés à l'URL courte d'un code QR, ils sont ajoutés à la charge utile. |
| Paramètres | Description |
|---|
| accuracy | Précision de numérisation en mètres. |
| anonymizedip | Adresse IP anonymisée du dispositif de numérisation. |
| code | URL courte du code QR. |
| country | Le pays où le code QR a été scanné. |
| device | L'appareil qui a scanné le code QR. |
| email | L'adresse e-mail de votre compte. |
| event | QR_CODE_SCANNED |
| lng/lat | Une information de localisation facultative avec une paire lng/lat si un utilisateur envoie ses données GPS. |
| mobile | Type de dispositif de numérisation. |
| os | Le système d'exploitation qui a scanné le code QR. |
| querystring | Lorsque des paramètres URL de requête sont ajoutés à l'URL courte d'un code QR, ils sont ajoutés à la charge utile. |
| redirects | Le nombre de fois où un code QR a été scanné. |
| secrettoken | La clé API secrète de votre compte. |
| timestamp | La date et l'heure exactes auxquelles le scan a été effectué. |
| type | Type de code QR/page de destination (URL = code QR dynamique, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING). |
| uniqueid | Identifiant unique de cette analyse spécifique. |
| user | Le nom d'utilisateur de votre compte. |
| visitors | Le nombre de visiteurs uniques qui ont scanné le code QR. |
Le code QR a été mis à jour
Ces paramètres sont également envoyés si l'URL cible du code QR est mise à jour.
| Paramètres | Description |
|---|
| url | Nouvelle URL cible du code QR mis à jour |
uniqevisitors
| Visiteurs uniques
|
redirect
| Nombre de redirections
|
title
| Titre du code QR
|
description
| Champ de description du code QR
|
Type
| URL, BUSINESS_CARD, PRODUCT, OPENIMMO, COUPON, PLAIN, LEAD, SOCIAL,TRACING
|
Subtype
| URL, FACEBOOK_PAGE, FACEBOOK_LIKE, INSTAGRAM, SKYPE, APPSTORE, YOUTUBE, TWITTER, LINKEDIN, SMS, EMAIL, TEXT, VCARD, WLAN, GEO, PAYPAL, PINTEREST, EVENT, PHONE, SEPA, MULTI, BITCOIN, VOUCHER, WHATSAPP, PDF, MULTI_LANGUAGE, MP3, MULTI_GEO, MULTI_GEO_CLOSEST, UNLIMITED, UNIQUEIP, UNIQUEID, ONE, GS1
|
| Creation date | Date de création du code QR |
Le coupon a été mis à jour
Ces paramètres sont également envoyés lorsqu'un bon a été mis à jour.
| Paramètres | Description |
|---|
| title | Le titre du bon |
| description | La description du bon |
| Le type de bon |
| type | Le type de bon |
| UNIQUEIP - Le bon peut être utilisé une seule fois par adresse IP. |
| UNIQUEID - Le bon peut être utilisé une seule fois. |
| productname | Nom facultatif du produit pour le bon d'achat |
| website | Une page Web facultative vers laquelle renvoie le bon. |
| couponnumber | Un numéro de bon facultatif qui sera affiché sur le bon. |
| validfrom | Une date facultative à partir de laquelle le bon est valable |
| validto | Une date facultative à partir de laquelle le bon expire |
Le bon a été échangé
| Paramètres | Description | |
|---|
| status | Statut du rachat: | |
| SUCCESS | Le bon a été utilisé. |
| VOUCHER_ALREADY_REDEEMED | Le bon a déjà été utilisé auparavant. |
| VOUCHER_EXPIRED | Le bon a expiré. |
| QUOTA_EXCEEDED | La limite des rachats a été dépassée. |
| type | Type de bon : | |
| UNIQUEIP | Le bon peut être utilisé une seule fois par adresse IP. |
| UNIQUEID | Le bon peut être utilisé une seule fois. |
| eancode | | Si le bon est utilisé et qu'un code-barres EAN est défini, le code EAN sera transmis dans le webhook. |
| uniqueid | | Si le code QR est un bon d'achat à usage unique, l'identifiant unique du bon d'achat est renvoyé. Il s'agit de l'un des identifiants uniques lorsque vous créez des codes QR en masse pour un bon d'achat à usage unique. |
Nouvelle piste
| Paramètres | Description |
|---|
| email | L'adresse e-mail du nouveau prospect |
| name | Le nom du nouveau responsable |
Le bouton C2A a été cliqué
| Paramètres | Description |
|---|
| c2a | L'URL du bouton Call-2-Action Lorem |
Le travail est terminé
Ce paramètre est également envoyé lorsqu'un travail qui fournit des codes QR de concepteur à télécharger est terminé avec le calcul.
| Paramètres | Description |
|---|
| download | Un lien pour télécharger le résultat du travail, valable pendant 30 jours. |
Les logs du webhook
Vous pouvez consulter les journaux à partir de vos paramètres utilisateur pour voir quels webhooks, quand ont été déclenchés et s'il y a eu une erreur.
Débogage
Si vous souhaitez afficher les informations envoyées à votre serveur sur un webhook, utilisez le script PHP suivant pour afficher tous les paramètres:
<?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')); Tester un webhook en ligne
Avec le service gratuit webhook.site vous pouvez immédiatement tester un webhook en ligne.
Copier la configuration d'un webhook vers un autre profil d'utilisateur.
L'API Administrateur vous permet de copier la configuration d'un webhook d'un profil d'utilisateur à un autre.