Recevoir les webhooks sur votre ordinateur

L’adresse du webhook doit être publique et en https. Pendant le développement, la CLI Zean reçoit les événements de l’App et les transmet à votre serveur, sur votre ordinateur. Rien à installer : npx le lance, avec Node.js 18 ou plus.

Lancer

1. Créez une clé CLI dans Paramètres de l’App > Développeurs > Webhook > « Clé CLI ». Voir Clés et secrets.
2. Lancez votre serveur et sa route de webhook, par exemple sur le port 5000.
3. Lancez la CLI Zean avec la clé CLI et l’adresse de cette route :

npx zean-cli listen --key zk_cli_your_cli_key --forward http://localhost:5000/zean/webhook

La carte « Événements de test » affiche cette commande avec votre clé, prête à copier. La clé peut aussi venir de l’environnement :

export ZEAN_CLI_KEY=zk_cli_your_cli_keynpx zean-cli listen --forward http://localhost:5000/zean/webhook

Ce qu’il affiche

• Au démarrage : le nom de l’App, l’adresse où il transmet et le secret d’écoute.
• Puis une ligne par appel : l’heure, l’événement, s’il s’agit d’un test, le code de réponse de votre serveur ou l’erreur, et la durée en millisecondes.

Le secret d’écoute

Chaque appel transmis porte les en-têtes Zean-Event et Zean-Signature, signé exactement comme un vrai appel, mais avec le secret d’écoute. Votre vérification de signature marche sans changement. Voir Vérifier la signature d’un webhook.

• En développement : le secret d’écoute, affiché par la CLI Zean.
• En production : le secret de signature du webhook.
• Le secret d’écoute reste le même jusqu’à ce que la clé CLI soit régénérée.

Ce qui est transmis

• Chaque vrai événement de l’App : il part vers l’adresse du webhook et vers chaque CLI Zean en cours.
• Les événements de test envoyés depuis Paramètres de l’App > Développeurs > Webhook : ils ne partent que vers la CLI Zean, avec test à true. Voir Recevoir les événements par webhook.
• Chaque appel apparaît aussi dans « Envois récents », avec « CLI Zean » comme destination.

Envoyer un événement de test

1. Laissez la CLI Zean tourner : la carte « Événements de test » le compte, et son bouton s’active.
2. Choisissez l’événement, puis « Envoyer un événement de test ».
3. La ligne s’affiche dans votre terminal, et l’appel dans « Envois récents » avec la réponse de votre serveur.

Limites et arrêt

• Jusqu’à 5 CLI Zean en même temps par App.
• Ctrl+C l’arrête.
• Régénérer la clé CLI arrête aussitôt chaque CLI Zean en cours, avec un message. Relancez-le avec la nouvelle clé, et mettez à jour le secret d’écoute sur votre serveur.