WebHooks

Les WebHooks vous permettent de recevoir depuis Vizito des notifications en temps réel sur différents évènements survenant dans votre compte. Cet article vous guide dans la mise en place des WebHooks et vous explique les évènements et les données qu’ils fournissent.

Que sont les WebHooks dans Vizito ?

Les WebHooks sont des messages automatiques envoyés par Vizito vers une URL déterminée lorsque certains évènements se produisent. Cela vous permet d’intégrer Vizito à d’autres systèmes ou services afin de réagir à ces évènements en temps réel. Note : les WebHooks ne sont disponibles que dans la formule Enterprise.

Quels évènements les WebHooks peuvent-ils envoyer ?

Les WebHooks peuvent être configurés pour envoyer les évènements suivants :

  • company_updated
  • device_added
  • device_online
  • device_offline
  • device_deleted
  • registered_visitor_created
  • registered_visitor_updated
  • registered_visitor_deleted
  • registered_visitor_preregistered
  • visitor_signed_in
  • visitor_signed_out
  • visitor_updated
  • visitor_screening_approved
  • visitor_screening_rejected

Paramètres de chaque évènement

Le tableau suivant répertorie les paramètres envoyés avec chaque évènement :

Évènement Paramètres
company_updated companyId
device_added companyId
deviceUuid
device_online companyId
deviceUuid
device_offline companyId
deviceUuid
device_deleted companyId
deviceUuid
registered_visitor_created companyId
knownVisitorId
visitTypeId
registered_visitor_updated companyId
knownVisitorId
visitTypeId
registered_visitor_deleted companyId
knownVisitorId
visitTypeId
registered_visitor_preregistered companyId
knownVisitorId
visitor_signed_in companyId
visitTypeId
visitorId
knownVisitorId
visitor_signed_out companyId
visitTypeId
visitorId
knownVisitorId
visitor_updated companyId
visitTypeId
visitorId
knownVisitorId
visitor_screening_approved companyId
visitorId
approvalStatus
knownVisitorId
visitor_screening_rejected companyId
visitorId
approvalStatus
knownVisitorId

Comment mettre en place des WebHooks dans Vizito

Suivez ces étapes pour configurer les WebHooks dans le backoffice Vizito :

Étape 1 : accéder à la page Intégrations

Connectez-vous à la page Intégrations du backoffice Vizito.

Étape 2 : activer le Webhook

  • Rendez-vous dans la section “Webhook”.
  • Basculez l’interrupteur “Activer le Webhook” en position activée.

Étape 3 : configurer les réglages du Webhook

  • URL du Webhook : saisissez l’URL vers laquelle Vizito doit envoyer les données du webhook (par exemple https://example.com/webhook).
  • Méthode HTTP : sélectionnez la méthode HTTP (par exemple POST, GET, PUT, PATCH). POST est recommandée.
  • Nom d’utilisateur (facultatif) : indiquez un nom d’utilisateur pour l’authentification basique si nécessaire.
  • Mot de passe (facultatif) : indiquez un mot de passe pour l’authentification basique si nécessaire.

Étape 4 : enregistrer la configuration

  • Cliquez sur le bouton “Sauvegarder” pour appliquer les réglages.

Étape 5 : tester le Webhook

  • Effectuez dans Vizito une action qui déclenche l’un des évènements du webhook (par exemple enregistrer un visiteur).
  • Vérifiez que votre URL de webhook reçoit bien les données attendues.

Résolution des problèmes

  • Aucune donnée reçue : vérifiez que l’URL du Webhook est correcte et accessible. Contrôlez les réglages du pare-feu ou du réseau.
  • Méthode HTTP invalide : confirmez que la méthode sélectionnée est prise en charge par votre point de terminaison.
  • Problèmes d’authentification : vérifiez le nom d’utilisateur et le mot de passe s’ils sont utilisés.

Notes complémentaires

  • Les WebHooks sont envoyés sous forme de requêtes HTTP avec une charge utile JSON contenant les données de l’évènement.
  • Assurez-vous que votre point de terminaison peut absorber le volume de requêtes, en particulier aux heures de pointe.
  • Si vous n’êtes pas sur la formule Enterprise et souhaitez utiliser les WebHooks, contactez-nous pour faire évoluer votre abonnement.