Webhooks : prévenir votre site qu’un billet a été vendu

Imaginons : vous voulez que le compteur de votre site bouge dès qu’un billet est vendu. Il y a deux façons d’y arriver, et l’une est nettement meilleure.

Cet article explique ce qu’est un webhook et si vous en avez besoin. Comment en configurer un, bouton par bouton, est expliqué dans Configurer des webhooks.

Le monde à l’envers

Sans webhook, votre site doit le demander sans arrêt. Chaque minute, toute la journée : « est-ce qu’il y a déjà eu une vente ? » La réponse est presque toujours non. Cela fait quatorze cents questions par jour pour entendre trois fois oui — et entre deux questions, votre compteur est faux.

Avec un webhook, vous inversez la chose. Vous nous donnez une adresse sur votre propre site, et dès que quelque chose se passe, nous y envoyons un message. Un seul message, au moment même.

D’où le nom : un hook est un crochet auquel nous accrochons quelque chose dès que c’est le moment.

Ce que vous pouvez en faire

• faire bouger le compteur de votre site dès qu’une vente a lieu ;
• recevoir un message dans votre chat d’équipe à chaque commande au-dessus d’un montant ;
• mettre à jour votre liste de membres quand quelqu’un achète un abonnement annuel ;
• vous envoyer un courriel quand une commande est annulée ;
• prévenir aussitôt votre caisse ou votre comptabilité que l’argent est arrivé.

Ce qu’il vous faut

Trois choses, et votre webmaster les connaît toutes les trois :

1. Une adresse sur votre site capable de recevoir des messages. C’est une page ordinaire que personne ne visite ; elle n’existe que pour recevoir notre message. Elle doit commencer par https://.
2. Un endroit où saisir cette adresse. Vous le faites vous-même, dans Paramètres → Accès API, sur l’onglet Webhooks — voir Configurer des webhooks. Si votre webmaster préfère le faire depuis son propre programme, il lui faut une clé avec le droit Webhooks ; voir Créer une clé API.
3. Le secret lié à cette adresse. Vous le recevez de nous dès que l’adresse est configurée, et votre site s’en sert pour vérifier qu’un message vient bien de nous.

Ce troisième point est important. Sans vérification du secret, n’importe qui devinant votre adresse peut faire croire à votre site qu’une vente a eu lieu. Avec la vérification, non.

À quoi cela ressemble

Un petit message arrive, qui dit ce qui s’est passé et à quel propos. Votre site regarde le secret, voit qu’il correspond, puis en fait quelque chose : incrémenter un compteur, écrire une ligne, envoyer un courriel.

Ce que contient exactement un tel message, et comment programmer la vérification du secret, se trouve dans le portail développeurs — c’est la page que vous transmettez à celui qui construit l’intégration.

Trois choses qui tournent souvent mal

Répondez vite. Notre message attend une réponse dix secondes au plus, pas jusqu’à ce que votre site ait fini tout son travail. Acceptez le message, dites qu’il est arrivé, et faites le travail ensuite.

Comptez sur des répétitions. Si votre site était momentanément injoignable, nous réessayons — jusqu’à six fois, sur un peu plus d’un jour et demi. Il peut donc arriver que le même message arrive deux fois. Faites en sorte que votre site le supporte — deux fois le même message ne doit pas donner deux fois le même courriel.

Gardez le secret secret. Il doit se trouver dans les réglages de votre serveur, pas dans du code qui aboutit sur votre site public.

Faut-il vraiment cela ?

Non. Un webhook est utile quand quelque chose doit se passer tout de suite. Si un aperçu quotidien suffit, vous n’en avez pas besoin — il suffit alors de récupérer les chiffres une fois par jour.

Les webhooks font partie de la même formule que le reste de l’API. Ce que contient chaque formule est indiqué sur la page des tarifs de Passavo.

Pour aller plus loin

• Configurer des webhooks — l’écran lui-même : ajouter une adresse, envoyer un message de test, lire le journal des messages.
• Qu’est-ce qu’une API, et en ai-je besoin ?
• Créer une clé API
• Le portail développeurs — pour celui qui construit l’intégration.