Aller au contenu principal

Configuration des webhooks Growth+This feature requires the Growth+ plan or higher

Les webhooks permettent à des applications externes de recevoir des notifications en temps réel lorsqu'un événement se produit dans votre compte EquipDash. Au lieu d'interroger l'API sans cesse, votre application reçoit instantanément une requête HTTP POST chaque fois qu'un événement sélectionné a lieu.


Créer un point de terminaison webhook​

  1. Cliquez sur Paramètres dans la barre latérale.
  2. Sélectionnez API et intégrations dans le menu des paramètres.
  3. Cliquez sur l'onglet Webhooks.
  4. Cliquez sur + Créer un webhook.
  5. Renseignez les champs suivants :
    • Nom -- un libellé descriptif (par exemple, « Synchronisation comptable », « Notifications Slack »).
    • URL -- l'adresse du point de terminaison où EquipDash doit envoyer les données du webhook (elle doit commencer par HTTPS).
    • Événements -- sélectionnez les événements qui doivent déclencher ce webhook (voir le tableau des événements ci-dessous).
    • Actif -- activez cette option pour commencer à recevoir les événements immédiatement.
  6. Cliquez sur Créer.

L'onglet Webhooks de la page des paramètres API et intégrations


Secret du webhook​

Après la création d'un webhook, EquipDash génère un secret de webhook. Ce secret sert à vérifier que les requêtes reçues proviennent bien d'EquipDash.

  1. Copiez le secret immédiatement et conservez-le en lieu sûr.
  2. Utilisez le secret pour valider l'en-tête X-Webhook-Signature des requêtes reçues.
attention

Le secret du webhook n'est affiché qu'une seule fois, au moment de la création du webhook. Si vous le perdez, vous pouvez le régénérer depuis la page de détail du webhook -- mais vous devrez alors mettre à jour votre application avec le nouveau secret.


Événements webhook disponibles​

Réservations​

ÉvénementSe déclenche lorsque
booking.createdUne nouvelle réservation est créée
booking.updatedUne réservation est modifiée
booking.cancelledUne réservation est annulée
booking.completedUne réservation est marquée comme terminée

Paiements​

ÉvénementSe déclenche lorsque
payment.receivedUn paiement est enregistré
payment.refundedUn remboursement est effectué

Clients​

ÉvénementSe déclenche lorsque
customer.createdUn nouveau client est ajouté
customer.updatedLa fiche d'un client est modifiée
customer.deletedUn client est supprimé

Produits​

ÉvénementSe déclenche lorsque
product.createdUn nouveau produit est ajouté
product.updatedUn produit est modifié
product.archivedUn produit est archivé

Expériences​

ÉvénementSe déclenche lorsque
experience.createdUne nouvelle expérience est ajoutée
experience.updatedUne expérience est modifiée
experience.archivedUne expérience est archivée

Formulaires​

ÉvénementSe déclenche lorsque
form_response.submittedUn client envoie une décharge ou un formulaire

Bons cadeaux​

ÉvénementSe déclenche lorsque
voucher.soldUn bon ou une carte cadeau est acheté
voucher.redeemedUn bon est utilisé pour une réservation

Gérer les webhooks​

Depuis l'onglet Webhooks, vous pouvez :

  • Modifier un webhook pour changer son nom, son URL ou les événements sélectionnés.
  • Mettre en pause un webhook en le désactivant. Aucun événement n'est envoyé pendant la pause.
  • Régénérer le secret si le secret de votre webhook a été compromis.
  • Supprimer un webhook pour l'effacer définitivement.

Vérifier les signatures des webhooks​

Chaque requête webhook comprend un en-tête X-Webhook-Signature. Pour vérifier qu'elle est authentique :

  1. Calculez un hachage HMAC-SHA256 du corps de la requête avec votre secret de webhook.
  2. Comparez le hachage calculé avec la valeur de l'en-tête X-Webhook-Signature.
  3. S'ils sont identiques, la requête est authentique.

Cela empêche des personnes malveillantes d'envoyer de faux événements webhook à votre point de terminaison.