Passer au contenu principal

Gérer vos webhooks

Comment créer, tester, modifier, mettre en pause et renouveler le secret de signature des webhooks dans les Paramètres, et comment migrer le

Cet article s'adresse aux gérants de studio qui envoient les événements bsport vers d'autres outils. Il couvre la création, le test, la mise en pause et la mise à jour des webhooks dans les Paramètres. Pour les clés API, consultez « Gérer vos clés API ».

Présentation

Un webhook informe un autre outil lorsqu'un événement se produit dans bsport. Lorsqu'un client réserve un cours ou qu'une facture est créée, bsport envoie les détails à une adresse web que vous choisissez. Votre outil de reporting, votre CRM ou votre plateforme d'automatisation peut alors réagir immédiatement, sans avoir à vérifier bsport en permanence.

Gérez tous vos webhooks depuis une seule page : Paramètres > Webhooks (répertorié sous Intégrations).

Cette page s'appelle Webhooks & APIs et comporte deux onglets : Webhooks et API. Cet article couvre l'onglet Webhooks.

Les webhooks existent en plusieurs versions :

  • V2 est la version actuelle, celle que vous créez.

  • V1 et Legacy sont d'anciennes versions qui continuent d'envoyer des événements jusqu'à ce que vous les remplaciez (voir « Anciens webhooks : V1 et Legacy » ci-dessous).

Qui peut l'utiliser : les gérants dont le rôle dispose de la permission Webhook. Demandez à l'administrateur de votre studio de l'activer pour votre rôle.

Ce que vous pouvez faire

  • Créer un webhook pour un événement et une URL de destination.

  • Modifier l'événement ou l'URL d'un webhook.

  • Envoyer un test pour vérifier que votre outil reçoit bien les événements.

  • Mettre un webhook en pause et le réactiver plus tard.

  • Copier ou renouveler le secret de signature d'un webhook.

  • Remplacer les anciens webhooks (V1 et Legacy) par des webhooks V2.

  • Filtrer la liste par Tous, Actifs ou En pause.

Cas d'usage courants

Comment envoyer les nouvelles réservations vers un autre outil

  1. Allez dans Paramètres > Webhooks et sélectionnez Créer un webhook.

  2. Dans Événement, recherchez et choisissez booking.created.

  3. Dans URL de destination, saisissez l'adresse de votre outil, par exemple https://example.com/webhooks/bsport.

  4. Sélectionnez Créer un webhook.

Le webhook est actif immédiatement. Créez un webhook par événement : pour suivre les réservations modifiées ou supprimées, ajoutez booking.updated et booking.deleted.

Comment vérifier que votre outil reçoit les événements

Sélectionnez l'icône d'envoi (Tester le webhook) sur la ligne du webhook. bsport envoie un échantillon avec des données fictives à votre URL et affiche le résultat :

Résultat

Ce que cela signifie

Livré

Votre outil a répondu avec un statut de succès.

Le destinataire a répondu avec une erreur

Votre outil a bien reçu l'échantillon mais a répondu avec un statut d'erreur. Le code de statut s'affiche.

Aucune réponse

bsport n'a reçu aucune réponse : l'outil a dépassé le délai, n'a pas pu être contacté, l'URL ne pointe pas vers une adresse publique, ou son certificat a été refusé.

Si vous testez trop fréquemment, bsport vous demande d'attendre une minute avant le prochain test.

Comment mettre un webhook en pause

Mettez un webhook en pause pour empêcher bsport d'envoyer son événement à votre outil, sans le supprimer. Son événement, son URL et son secret de signature restent enregistrés.

Utilisez cette option lorsque votre outil est hors service ou en cours de mise à jour, ou après avoir remplacé un webhook V1 par un webhook V2.

Pour mettre en pause, désactivez le commutateur Actif sur la ligne du webhook (sur téléphone, sélectionnez plutôt Mettre le webhook en pause)

Rien n'est envoyé tant que le webhook est en pause.

Pour le réactiver, réactivez le commutateur, ou sélectionnez Reprendre le webhook.

Comment protéger votre outil contre les faux événements

Chaque webhook dispose d'un Secret de signature, affiché masqué avec ses 4 derniers caractères. Votre outil l'utilise pour vérifier qu'un événement provient bien de bsport. Sélectionnez l'icône de copie pour copier le secret dans votre outil.

Pour remplacer le secret, sélectionnez l'icône de renouvellement (Renouveler le secret) et confirmez. Le secret actuel cesse de fonctionner immédiatement, y compris pour les nouvelles tentatives. Mettez à jour votre outil avec le nouveau secret sans attendre.

Fonctionnement

  1. Configuration. Créez un webhook avec un événement et une URL publique. Utilisez une adresse commençant par https:// ou http://. Les adresses locales et privées sont refusées.

  2. Utilisation normale. Chaque fois que l'événement se produit dans bsport, bsport envoie le nom de l'événement, sa date et les données associées à votre URL. La liste des événements et le contenu de chaque envoi figurent dans la documentation Webhooks (également accessible en haut à droite de la page).

  3. Modifications. Modifiez l'événement ou l'URL avec l'icône crayon (Modifier le webhook), puis sélectionnez Enregistrer les modifications.

  4. Mise en pause ou changement de secret. Mettez en pause pour arrêter les envois. Renouvelez le secret si vous pensez qu'il a été compromis.

Événements disponibles

La liste des événements peut évoluer. La documentation Webhooks est toujours à jour et décrit chaque événement ainsi que ce que bsport envoie. Consultez-la avant de choisir un événement.

28 événements répartis sur 11 ressources. Chaque nom d'événement comporte la ressource, puis l'action qui s'est produite.

Ressource

Événements

Réservation

booking.created, booking.updated, booking.deleted

Cours

class.created, class.updated

Client

client.created, client.updated, client.tag_added, client.tag_removed

Professeur

teacher.created, teacher.updated, teacher.deleted

Facture

invoice.created, invoice.updated

Rendez-vous

appointment.created, appointment.updated, appointment.canceled

Prestation

service.created, service.updated

Établissement

venue.created, venue.updated, venue.deleted

Forfait

class_pass.created, class_pass.updated

Forfait client

client_class_pass.created, client_class_pass.updated

Produit

product.created, product.updated

Comportements importants

Un seul webhook actif par événement et par URL

bsport refuse la création d'un second webhook actif envoyant le même événement vers la même URL. Pour réactiver un webhook en pause qui ferait doublon avec un webhook actif, mettez d'abord ce dernier en pause.

Anciens webhooks : V1 et Legacy

Votre liste peut afficher d'anciens webhooks aux côtés des webhooks V2. Une bannière jaune indique le nombre d'anciens webhooks qui envoient encore des événements (« à mettre à jour »). Ils cesseront bientôt de fonctionner : migrez chacun d'eux vers la V2.

Type

Où il apparaît

Ce que vous pouvez faire

V2

Tableau Webhooks, Version V2

Tester, modifier, mettre en pause, copier ou renouveler le secret.

V1

Tableau Webhooks, Version V1

Mettre en pause, ou Mettre à jour vers la V2. Pas de renouvellement de secret.

Legacy

Tableau Webhooks Legacy

Mettre à jour vers la V2, ou Désactiver. Pas de mise en pause, pas de secret de signature.

Pour migrer un webhook V1 :

  1. Sélectionnez Mettre à jour vers la V2 sur sa ligne. Le formulaire s'ouvre avec l'événement V2 correspondant et la même URL.

  2. Choisissez Quel webhook doit recevoir les événements ?

    • Mettre en pause le V1 : le nouveau webhook V2 reçoit les événements.

    • Conserver le V1 actif : le nouveau webhook V2 démarre en pause. Réactivez-le lorsque votre outil est prêt.

  3. Sélectionnez Créer un webhook.

Pour migrer un webhook Legacy : sélectionnez Mettre à jour vers la V2 et créez le webhook V2. Le webhook Legacy continue de fonctionner jusqu'à ce que vous sélectionniez Désactiver.

  • La désactivation est définitive. Elle supprime le webhook Legacy de façon permanente, et son événement n'est plus envoyé. Pour recevoir cet événement à nouveau, créez un webhook V2.

  • Pas d'équivalent V2. Les événements liés aux formules de facturation n'ont pas d'équivalent V2 : l'option Mettre à jour vers la V2 est donc désactivée pour eux. Consultez le guide de migration des webhooks Legacy et le guide de migration des webhooks V1.

Qui voit quoi

Toute personne disposant de la permission Webhook voit l'onglet Webhooks. L'onglet API est distinct et réservé aux Propriétaires et aux Administrateurs. Consultez « Gérer vos clés API ».

FAQ

Je ne vois pas Paramètres > Webhooks. Pourquoi ?

  • Votre rôle ne dispose pas de la permission Webhook. Demandez à l'administrateur de votre studio de l'ajouter à votre rôle.

Puis-je supprimer un webhook V2 ?

  • Non. Mettez-le en pause à la place. Un webhook en pause n'envoie rien.

Pourquoi mon URL est-elle refusée ?

  • L'URL doit être publique et commencer par https:// ou http://. Les adresses locales et privées, comme localhost, sont refusées.

Le test indique « Aucune réponse ». Que dois-je vérifier ?

  • Vérifiez que votre outil fonctionne, que l'URL est publique et que son certificat est valide. Puis testez à nouveau.

Puis-je voir le secret de signature en entier ?

  • Le tableau n'affiche que les 4 derniers caractères. Utilisez l'icône de copie pour copier le secret complet.

Pourquoi ne puis-je pas renouveler le secret d'un webhook V1 ?

  • Le renouvellement est réservé aux webhooks V2. Créez un webhook V2 pour obtenir un secret renouvelable.

Articles associés

Avez-vous trouvé la réponse à votre question ?