Webhooks
- Le webhook est un outil puissant pour permettre au logiciel Hostaway d'envoyer des données de réservation à des fournisseurs de logiciels tiers prenant en charge les webhooks
- Lorsque vous configurez le webhook pour votre logiciel tiers, certains nécessiteront un exemple des données de réservation pour compléter la configuration. Vous pouvez créer le webhook dans Hostaway et définir l'URL dans ce logiciel tiers
- Après cela, vous pouvez effectuer une réservation directe "fictive" dans Hostaway sous le menu des réservations. Cela enverra les données environ 5 à 10 minutes plus tard au tiers afin que vous puissiez compléter la configuration
- Pour tester les webhooks et voir à quoi ils ressemblent dans la charge utile, vous pouvez utiliser ce site web.
Webhook unifié
Avant le 1er avril 2022, nous avions deux webhooks - un pour les réservations et un autre pour les messages des invités. Nous avons publié une nouvelle version connue sous le nom de webhook unifié qui présente les avantages suivants :
-
Il suffit de s'abonner à un seul webhook pour recevoir les mises à jour.
-
Le webhook unifié déclenche plus d'événements que le précédent webhook de réservations.
Le webhook unifié se déclenchera dans les cas suivants
-
Message reçu de l'invité
-
Les webhooks de messagerie ne sont déclenchés que pour les messages des invités, pas pour les messages des hôtes
-
-
Statut de la réservation modifié (Nouveau, Modifié, Annulé, etc.)
- Statut de paiement modifié. Les frais payés qui ne mettent pas à jour le statut de paiement ne déclenchent pas le webhook. Si le frais modifie le statut de paiement (par exemple, de non payé à partiellement payé, ou de partiellement payé à payé), le webhook est déclenché
-
Dates/heures de réservation modifiées
-
Prix total modifié
-
Code de porte modifié
Si les conditions suivantes ne sont pas remplies, le webhook ne fonctionnera pas
Hostaway vérifie 4 éléments dans les URL lorsque vous ajoutez/mettez à jour l'URL des webhooks unifiés dans cet ordre :
- Si l'URL est valide. Les contraintes sont ici
- Si l'hôte de l'URL est dans un réseau interne à des fins de sécurité, pour éviter d'accéder à toute application interne
- Si le schéma de l'URL est l'un de ces schémas pris en charge :
- HTTP
- HTTPS (recommandé)
- Si le port (s'il est donné) de l'URL est l'un de ces ports pris en charge :
80 (port http par défaut)
443 (port https par défaut)
Utilisation du webhook unifié
- Connectez-vous en tant que propriétaire du compte administrateur à votre tableau de bord Hostaway
- Allez dans le menu paramètres > Intégrations
- Ajoutez l'URL du webhook pour le webhook qui doit être adressé.
- Optionnellement, sélectionnez les annonces et les canaux, et si nécessaire, protégez-les avec un nom d'utilisateur et un mot de passe
Notes importantes à considérer :
- Le webhook se déclenchera dès que les données les plus pertinentes seront prêtes. Dans certains cas, vous pouvez constater que les champs complexes et les données qui arrivent plus tard ne sont pas fournis à ce moment-là. Nous continuons d'améliorer le webhook pour fournir plus de données dans les charges utiles au fil du temps.
- Lors de l'utilisation de webhooks universels en combinaison avec l'API publique, envisagez d'appeler l'API par la suite pour récupérer les détails mis à jour non inclus dans le webhook si nécessaire.
- Nous prévoyons de publier un point de terminaison API public pour créer et mettre à jour la création de webhooks d'ici la fin de 2022.
À déprécier au cours de l'année 2024 :
- À ce moment, Hostaway prend également en charge les 2 anciennes versions de webhook dans les modules de webhook spécifiques à la réservation et spécifiques aux messages ainsi que dans la documentation de l'API
- Ces systèmes de webhook sont prévus pour être supprimés en 2024 lorsque tous les clients seront invités à migrer vers le nouveau système de webhook universel
- Nous recommandons de commencer à utiliser le système de webhook universel dans toute nouvelle application construite ou connectée.
Que faire lorsque vous recevez une notification concernant un échec de webhook :
1. Allez dans "Paramètres > Intégrations", descendez sur la page jusqu'à la section webhook et cliquez sur "Logs" :
2. Cliquez sur le bouton pour exporter le CSV
3. Ouvrez le fichier CSV sur votre ordinateur et filtrez par ID d'objet (qui est l'ID de réservation) et voyez ce qui est indiqué dans le champ "Corps de la réponse".
Si tout se passe bien, il indiquera "200", sinon c'est une erreur fournie par le logiciel tiers que vous intégrez via le webhook et vous devrez contacter le logiciel tiers pour demander pourquoi une telle erreur s'est produite