Ajouter un webhook
Un webhook est une adresse de votre système où Finaxis envoie un événement chaque fois que les données auxquelles il est abonné changent. Votre ERP apprend qu'une facture est payée, votre CRM qu'un client a répondu, sans interroger l'API sans arrêt. Finaxis envoie l'événement quel que soit l'auteur du changement : votre système par l'API, une personne dans Finaxis, ou une synchronisation QuickBooks, Acomba ou HubSpot.
Avant de commencer
- Un webhook appartient à un identifiant d'API et ne reçoit que ce que cet identifiant peut lire. Créez d'abord l'identifiant : un compte de service ou un identifiant personnel.
- Un administrateur ajoute les webhooks des comptes de service de l'instance. Chaque membre ajoute les webhooks de ses propres identifiants personnels.
- Votre système doit avoir une adresse HTTPS capable de recevoir les événements.
Ajouter le webhook
- Ouvrez la page API. Pour un compte de service, cliquez sur Paramètres, puis sur API. Pour un de vos identifiants personnels, cliquez sur votre nom en haut à droite, sur Mon profil, puis sur API.
- Sous Webhooks, cliquez sur Ajouter un webhook.
- Dans Identifiant, choisissez l'identifiant auquel le webhook appartient.
- Dans URL, inscrivez l'adresse HTTPS de votre système qui reçoit les événements.
- Dans Événements, choisissez un ou plusieurs événements, une famille entière comme invoice.*, ou Tous les événements (*).
- Cliquez sur Ajouter. Si Finaxis vous demande de confirmer votre mot de passe, inscrivez-le, puis cliquez sur Confirmer.
- Sous Secret du webhook, copiez le secret et donnez-le à votre système, puis fermez la fenêtre.
À noter : Finaxis affiche le secret du webhook une seule fois. Si vous le perdez, supprimez le webhook et ajoutez-le de nouveau.
Le webhook apparaît ensuite sous Webhooks, avec son adresse, son statut, son identifiant et ses événements.
Choisir les événements
Chaque événement exige que l'identifiant puisse lire son objet. Un identifiant qui a seulement invoices:read, par exemple, peut s'abonner aux événements des factures, mais pas à ceux des paiements.
| Famille | Événements | Portée que l'identifiant doit avoir |
|---|---|---|
| customer.* | customer.created, customer.updated, customer.deleted | customers:read |
| contact.* | contact.created, contact.updated, contact.deleted | customers:read |
| invoice.* | invoice.created, invoice.updated, invoice.deleted, invoice.balance_changed, invoice.paid | invoices:read |
| payment.* | payment.created, payment.updated, payment.deleted | payments:read |
| promise.* | promise.created, promise.updated, promise.deleted, promise.due (ententes de paiement) | collections:read |
| note.* | note.created | collections:read |
| reminder.* | reminder.sent | collections:read |
| reply.* | reply.received | collections:read |
Chaque événement indique qui l'a causé, ce qui permet à votre système de reconnaître ses propres changements et de les ignorer.
Vérifier qu'un événement vient de Finaxis
Chaque événement porte un en-tête Finaxis-Signature, signé avec le secret du webhook. Votre système le vérifie avant de se fier à l'événement. Un événement peut aussi arriver deux fois : son identifiant permet à votre système d'ignorer le doublon. La section Webhooks de la documentation de l'API, en anglais, explique les deux, avec un exemple : api.finaxis.ai/docs.
Votre système répond à chaque événement par un code de succès en moins de 10 secondes. Pour suivre ce qui a été envoyé, consultez Consulter le journal des événements d'un webhook.
Dépannage
| Situation | Quoi faire |
|---|---|
| Finaxis refuse le webhook et nomme des portées | L'identifiant ne peut pas lire ces événements. Ajoutez-lui les portées qui manquent avec Modifier, ou choisissez d'autres événements. |
| Un identifiant manque dans la liste Identifiant | Dans Mon profil, vous ne voyez que vos propres identifiants personnels. Les assistants IA connectés à Finaxis ne sont pas offerts pour les webhooks. |
| Vous avez perdu le secret du webhook | Supprimez le webhook, puis ajoutez-le de nouveau. Finaxis affiche un nouveau secret. |
Votre système ne reçoit pas les événements? Écrivez à support@finaxis.ai avec l'adresse du webhook, et notre équipe vous aidera.
Articles liés
Vous ne trouvez pas ce que vous cherchez?
Notre équipe de soutien est là pour vous aider.