Liste des événements disponibles pour les Webhooks
Ci-dessous tous les événements disponibles sont regroupés par ressource :
- Client
- Abonnement
- Facture & Facture d’avoir
- Moyen de paiement
Evènements liés aux clients
Section titled “Evènements liés aux clients”| Nom | Ressource | Code technique | Description |
|---|---|---|---|
| Client ajouté | Client | CustomerAdded | Envoyé lorsqu’un nouveau client est ajouté dans ProAbono. |
| Adresse de facturation modifiée | Client | CustomerBillingAddressUpdated | Envoyé lorsque l’adresse de facturation d’un client est mise à jour. |
| Paramètre de paiement modifié | Client | CustomerSettingsPaymentUpdated | Envoyé lorsqu’un mode de paiement d’un client est mis à jour. |
| Facturation réussie | Client | CustomerBillingSucceeded | Envoyé lorsque la facturation d’un client a réussi. |
| Échec de la facturation | Client | CustomerBillingFailed | Envoyé lorsque la facturation d’un client a échoué. |
| Prélèvement réussi | Client | CustomerChargingSucceeded | Envoyé lorsquun prélèvement a réussi. |
| Prélèvement en cours | Client | CustomerChargingPending | Envoyé lorsqu’un prélèvement en cours. |
| Échec du prélèvement | Client | CustomerChargingFailed | Envoyé lorsqu’un prélèvement échoue. |
| Prélèvement auto en échec : pas de moyen de paiement valide | Client | CustomerChargingAutoFailedNoPermission | Envoyé lorsque un prélèvement auto a échoué car pas de moyen de paiement valide. |
| Un prélèvement auto est en échec et ne peut pas être retenté | Client | CustomerChargingAutoFailedNoRetry | Envoyé lorsqu’un prélèvement auto échoue et ne peut pas être retenté |
| Client suspendu | Client | CustomerSuspended | Envoyé lorsqu’un client est suspendu. Cette action ne peut pas être effectuée par un client. Seulement à partir de l’API ou du Backoffice. |
| Client activé | Client | CustomerEnabled | Envoyé lorsqu’un client est activé. Cette action ne peut pas être effectuée par un client. Seulement à partir de l’API ou du Backoffice. |
| Ajouté à la liste grise | Client | CustomerIsGreyListed | Envoyé lorsqu’un client est ajoutée à la liste grise. Cela se produit après qu’un comportement suspect a été détecté sur les formulaires de paiement affichés dans les pages hébergées. |
Evènements liés aux abonnements
Section titled “Evènements liés aux abonnements”| Nom | Ressource | Code technique | Description |
|---|---|---|---|
| Abonnement démarré | Abonnement | SubscriptionStarted | Envoyé lorsqu’un abonnement a démarré. |
| Abonnement renouvelé | Abonnement | SubscriptionRenewed | Envoyé lorsqu’un abonnement est automatiquement renouvelé. |
| Abonnement suspendu par un client | Abonnement | SubscriptionSuspendedCustomer | Envoyé lorsqu’un abonnement est suspendu depuis l’API ou Backoffice. |
| Abonnement redémarré par un client | Abonnement | SubscriptionRestarted | Envoyé lorsqu’un abonnement a redémarré. |
| Abonnement interrompu (pas d’info de paiement) | Abonnement | SubscriptionSuspendedPaymentInfoMissing | Envoyé lorsqu’un abonnement payant est interrompu pendant le processus de renouvellement parce que le client ne dispose pas d’un moyen de paiement valide. (pas de moyen de paiement du tout ou pas de moyen de paiement valide). Si les abonnements ne doivent pas s’arrêter sur ce critère, allez dans la configuration du paiement dans Paramètres et modifier le paramètre “Bloque les échéances si le client n’a pas de moyen de paiement”. |
| Abonnement interrompu (défaut de paiement) | Abonnement | SubscriptionSuspendedPaymentDue | Envoyé lorsqu’un abonnement payant est interrompu pendant le processus de renouvellement en raison du dépassement d’un des seuils liés aux factures impayées. Il y a 2 limites : le montant et la durée. Voir la configuration du paiement dans les Paramètres. |
| Abonnement résilié à l’échéance | Abonnement | SubscriptionTerminatedAtRenewal | Envoyé lorsqu’une demande de résiliation d’un abonnement est effectuée. Cette demande peut être faite depuis l’API, le Backoffice ou les pages hébergées (par le client lui-même). |
| Abonnement résilié | Abonnement | SubscriptionTerminated | Envoyé lorsqu’un abonnement est résilié. L’abonnement ne peut pas être redémarré. Il s’agit d’un état final. |
| Abonnement terminé | Abonnement | SubscriptionHistory | Envoyé lorsqu’un abonnement est terminé. Le nombre de renouvellements d’un abonnement peut être limité. Ex : 20 $/mois pendant 6 mois. Ainsi, lorsqu’un abonnement atteint sa limite de renouvellements, il cesse d’être actif et est terminé. |
| Abonnement supprimé | Abonnement | SubscriptionDeleted | Envoyé lorsqu’un abonnement est supprimé. Cette action ne peut pas être effectuée par un client. Seulement à partir de l’API ou du Backoffice. |
| Abonnement modifié | Abonnement | SubscriptionUpdated | Envoyé lorsqu’un abonnement est mis à jour. Il concerne toutes les mises à jour de l’abonnement, à l’exception des mises à jour des fonctionnalités et de la date d’échéance. Voir les événements “Abonnement - date d’échéance modifiée” et “Abonnement - caractéristiques modifiées”. |
| Caractéristiques modifiées | Abonnement | SubscriptionFeaturesUpdated | Envoyé lorsqu’une caractéristique de l’abonnement est mise à jour. |
| Abonnement démarré comme upgrade | Abonnement | SubscriptionUpgraded | Envoyé lorsqu’un nouvel abonnement est démarré lors d’un changement d’offre. Lors d’un changement d’offre, un nouvel abonnement est démarré et un abonnement est résilié. |
| Abonnement résilié pour upgrade | Abonnement | SubscriptionTerminatedForUpgrade | Envoyé lorsqu’un abonnement est résilié lors d’un changement d’offre. Lors d’un changement d’offre, un nouvel abonnement est démarré et un abonnement est résilié. |
| Date d’échéance modifiée | Abonnement | SubscriptionDateTermUpdated | Envoyé lorsque la date d’échéance d’un abonnement est mise à jour. Cette action ne peut pas être effectuée par un client. Seulement à partir de l’API ou du Backoffice. |
Evènements liés aux factures
Section titled “Evènements liés aux factures”| Nom | Ressource | Code technique | Description |
|---|---|---|---|
| Facture émise, prélèvement programmé | Facture | InvoiceDebitIssuedPaymentAuto | Facture - émise, prélèvement programmé Envoyé lorsqu’une facture est émise et que son paiement est automatique (carte bancaire, mandat Sepa, …). |
| Facture à payer | Facture | InvoiceDebitIssuedPaymentOffline | Envoyé lorsqu’une facture est émise et que son paiement est offline (virement bancaire, chèque, espèces, autre). |
| Facture payée | Facture | InvoiceDebitPaid | Envoyé lorsqu’une facture est honorée. |
| Facture remboursée | Facture | InvoiceDebitRefunded | Envoyé lorsqu’une facture est remboursée. Une facture d’avoir est également émise. |
| Facture annulée | Facture | InvoiceDebitCancelled | Envoyé lorsqu’une facture est annulée. Une facture d’avoir est également émise. |
| Échec du paiement auto | Facture | InvoiceDebitPaymentAutoFailed | Envoyé lorsqu’une facture vient de passer au statut “échec du paiement automatique”. Toutes les tentatives de prélèvement automatique de cette facture ont échoué. Le client doit être contacté pour régler la facture non-payée. Voir la section “E-mails du client” dans les Paramètres, ProAbono peut envoyer automatiquement un e-mail au client. |
| Prélèvement auto rejeté : authentification du paiement requise | Facture | InvoiceDebitPaymentAutoRequestedAuth | Envoyé lorsqu’un prélèvement auto est rejeté et qu’une authentification du paiement requise. |
| Facture en retard | Facture | InvoiceDebitOverdue | Envoyé lorsqu’une facture est en retard. 60 jours après avoir été émise/créée, une facture non payée est considérée comme “en retard”. |
| Facture en litige | Facture | InvoiceDebitDisputed | Envoyé lorsqu’une facture est contestée, en litige. Cela se produit automatiquement ou manuellement. Automatiquement lorsque la passerelle de paiement envoie l’information à ProAbono. Manuellement lorsque la facture est contestée via l’API ou Backoffice. |
| Facture - non recouvrable | Facture | InvoiceDebitUncollectible | Envoyé quand une facture est marquée non-recouvrable |
| Facture d’avoir émise | Facture d’avoir | InvoiceCreditIssued | Envoyé lorsqu’une facture d’avoir est émise. Cela se produit lorsqu’une facture est annulée ou remboursée. |
Evènements liés aux moyens de paiement
Section titled “Evènements liés aux moyens de paiement”| Nom | Ressource | Code technique | Description |
|---|---|---|---|
| Moyen de paiement expire bientôt | Moyen de paiement | GatewayPermissionSoonExpired | Moyen de paiement - expire bientôt Envoyé lorsque la moyen de paiement d’un client expire bientôt. Voir section “E-mails du client” dans Paramètres, pour éviter toute expiration, ProAbono peut envoyer automatiquement au client jusqu’à 3 e-mails : 30, 7 et 1 jour avant la date d’expiration. |
| Moyen de paiement expire | Moyen de paiement | GatewayPermissionExpired | Envoyé lorsque le moyen de paiement d’un client a expiré. Voir section “E-mails clients” dans les paramètres, ProAbono peut envoyer automatiquement un e-mail au client. |
| Moyen de paiement défectueux | Moyen de paiement | GatewayPermissionDefective | Envoyé lorsqu’un moyen de paiement est défectueux. Défectueux signifie que ProAbono ne peut plus utiliser ce moyen de paiement. (ex. : carte bancaire volée, perdue, bloquée, mandat SEPA devenu invalide, etc.) Voir section “E-mails clients” dans les paramètres, ProAbono peut envoyer automatiquement un e-mail au client. |
| Fonds insuffisants | Moyen de paiement | GatewayPermissionInsufficientFunds | Envoyé lorsqu’un prélèvement a échoué en raison de “fonds insuffisants”. ProAbono va essayer de prélever à nouveau le client. Voir section “E-mails clients” dans les paramètres, ProAbono peut envoyer automatiquement un e-mail au client. |
| Incidents de paiement | Moyen de paiement | GatewayPermissionPaymentIssues | Envoyé lorsque plusieurs incidents de paiement se sont produits avec les mêmes informations de paiement d’un client. Au prochain échec, son moyen de paiement seront désactivé. |
Pour en savoir plus sur ce qu’est un webhook et comment en créer dans ProAbono, veuillez consulter l’artcile suivant :