Utiliser les webhooks pour connecter WorkZen

Les webhooks sont la façon dont WorkZen communique avec le reste de votre écosystème en temps réel : un prospect arrive et votre canal Slack reçoit une alerte, une facture est payée et votre feuille de calcul se met à jour, le tout via Zapier, Make ou votre propre code, sans interrogation périodique.

Créer un webhook

Allez dans Paramètres > Intégrations > Webhooks (nécessite l'autorisation Gérer les intégrations).
Cliquez sur Ajouter un Webhook.
Entrez l'URL du point de terminaison qui doit recevoir les événements, et facultativement une description (« Hook Zapier production »).
Sous Événements abonnés, choisissez des événements individuels ou sélectionnez des catégories entières.
Cliquez sur Créer le Webhook, puis copiez la Clé de signature qui s'affiche.

Cliquez sur Envoyer un test sur le nouveau point de terminaison pour déclencher un événement de test et confirmer que votre récepteur répond.

Événements disponibles

Catégorie	Événements
Prospects	`lead.created`, `lead.status_changed`, `lead.converted`
Clients	`client.created`
Travaux	`job.created`, `job.status_changed`, `job.completed`
Estimations	`estimate.created`, `estimate.sent`, `estimate.accepted`, `estimate.declined`
Factures	`invoice.created`, `invoice.sent`, `invoice.paid`, `invoice.overdue`
Paiements	`payment.received`

Chaque livraison est une requête HTTP POST avec une charge utile JSON décrivant l'événement et l'enregistrement concerné.

Vérifier la signature

Chaque livraison inclut un en-tête X-WorkZen-Signature :

code

X-WorkZen-Signature: sha256=<hex digest>

Il s'agit d'un HMAC-SHA256 du corps brut de la requête, à l'aide de la clé de signature de votre point de terminaison. Recalculez-le de votre côté et comparez-le avant de faire confiance à la charge utile. Changer la clé génère une nouvelle clé chaque fois que vous en avez besoin ; mettez à jour votre récepteur en même temps, car les signatures de l'ancienne clé cessent immédiatement de correspondre.

Warning

Traitez la clé de signature comme un mot de passe. Quiconque la possède peut falsifier des événements qui passeront votre vérification.

Livraison, nouvelles tentatives et journal

Nouvelles tentatives : une livraison échouée est retentée jusqu'à 4 tentatives au total, avec des délais croissants (10 secondes, 1 minute, 10 minutes).
Désactivation automatique : après 10 échecs consécutifs, le point de terminaison est désactivé et vous recevez une notification. Corrigez le récepteur, puis remettez-le à Actif.
Journal des livraisons : chaque point de terminaison conserve un journal des livraisons récentes avec la charge utile complète, le statut de la réponse et un bouton de nouvelle tentative manuelle, ce qui rend le débogage d'un récepteur défaillant étonnamment simple.

Zapier et Make

Les deux fonctionnent immédiatement : créez-y un déclencheur « catch webhook », collez l'URL qu'il vous fournit dans un webhook WorkZen, puis abonnez-vous aux événements qui vous intéressent. À partir de là, votre plateforme d'automatisation prend le relais.

Étape par étape

Créer le point de terminaison

Allez dans Paramètres > Intégrations > Webhooks, cliquez sur Ajouter un Webhook, puis entrez l'URL qui doit recevoir les événements.

Choisissez vos événements

Abonnez-vous à des événements individuels ou à des catégories entières (prospects, clients, travaux, estimations, factures, paiements).

Enregistrez la clé de signature

Copiez la clé de signature affichée après la création et utilisez-la pour vérifier l'en-tête X-WorkZen-Signature de chaque livraison.

Envoyez un test

Cliquez sur Envoyer un test pour déclencher un événement de test vers votre point de terminaison et confirmer qu'il répond correctement.

Frequently Asked Questions

Un point de terminaison sur ZenGrow, cinq sur ZenAI.

Chaque livraison comporte un en-tête X-WorkZen-Signature sous la forme sha256=hexdigest, un HMAC-SHA256 du corps brut de la requête utilisant la clé de signature de votre point de terminaison. Calculez-le de votre côté et comparez-le.

WorkZen retente une livraison échouée 3 fois de plus (4 tentatives au total), avec des délais croissants de 10 secondes, 1 minute, puis 10 minutes. Les livraisons échouées restent dans le Journal des livraisons, où vous pouvez les relancer manuellement.

Après 10 livraisons échouées consécutives, WorkZen désactive le point de terminaison et vous en avertit, afin qu'une URL non fonctionnelle n'accumule pas les échecs indéfiniment. Corrigez le point de terminaison, puis réactivez-le.

Cela génère immédiatement une nouvelle clé de signature. Les livraisons continuent, mais votre intégration échouera aux vérifications de signature jusqu'à ce que vous la mettiez à jour avec la nouvelle clé.