Événements Webhook pour l'adhésion en détail
Pour commencer
Cet article aborde brièvement les événements et les charges utiles appelées lors d'un événement webhook.
| Nom de l'événement | Quand sera-t-il déclenché ? |
|---|---|
| ajouter un membre | Lorsqu'un nouvel utilisateur souscrit au plan gratuit ou lorsqu'un nouveau membre de l'équipe est ajouté. |
| mise à jour des membres | Lorsqu'un membre existant met à jour son adresse électronique ou son nom. |
| supprimer un membre | Lorsqu'un utilisateur est retiré de la liste des membres |
| ajouter un abonnement | Lorsqu'un utilisateur achète un plan payant |
| mise à jour de l'abonnement | Lorsqu'un membre payant passe à un plan gratuit ou passe d'un plan annuel à un plan mensuel ou vice versa. |
| annuler l'abonnement | Lorsqu'un utilisateur annule son abonnement |
Membre ajouté
Un ajouter un membre est déclenché lorsque de nouveaux utilisateurs s'inscrivent au plan gratuit.
Informations envoyées dans la charge utile d'un ajouter un membre est résumée dans le tableau ci-dessous.
Charge utile
| Propriété | Type | Description | Exemple |
|---|---|---|---|
| nom | Chaîne | Le nom du membre ajouté | "John" |
| courrie | Chaîne | L'adresse électronique du membre ajouté | abc@abc.com |
| ID utilisateur | Chaîne | L'ID utilisateur du membre ajouté | 644094d7f939e67758 |
| Nom de l'événement | Chaîne | Nom de l'événement | ajouter un membre |
| eventId | Chaîne | L'identifiant unique de l'événement | ajouter-membre-fj30fer |
| l'adhésion | Objet | Cet objet contiendra la valeur des informations relatives à l'adhésion (par exemple, customerId, subscriptionId). |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description | Exemple |
|---|---|---|---|
| identifiant du client (customerId) | Chaîne | L'identifiant du client du membre ajouté | cus_43fdf43nkkdf |
| subscriptionId | Chaîne | L'identifiant d'abonnement du membre | subs_4e**** ou null(si membre libre) |
| planId | Chaîne | L'identifiant du régime d'un membre ajouté sera gratuit | ou null(si membre libre) |
| statut | Chaîne | Statut de l'abonnement | |
| Renouveler | Date | Date de renouvellement de l'abonnement | |
| cancellationEffectiveDate | Date | Date à laquelle l'annulation prendra effet |
Membre mis à jour
Un mise à jour des membres est déclenché lorsqu'un membre existant met à jour son adresse électronique ou son nom.
Informations envoyées dans la charge utile d'un mise à jour des membres est résumée dans le tableau ci-dessous.
Charge utile
| Propriété | Type | Description |
|---|---|---|
| nom | Chaîne | Le nom actualisé du membre existant |
| courriel | Chaîne | L'adresse électronique mise à jour du membre existant |
| ID utilisateur | Chaîne | L'identifiant du membre |
| Nom de l'événement | Chaîne | Nom de l'événement |
| eventId | Chaîne | L'ID de l'événement |
| l'adhésion | Objet | Cet objet sera envoyé à un payload contenant la valeur de l'adhésion. |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description |
|---|---|---|
| identifiant du client (customerId) | Chaîne | Numéro d'identification du membre |
| subscriptionId | Chaîne | ID d'abonnement du membre |
| planId | Chaîne | L'ID du plan auquel l'utilisateur a souscrit |
| statut | Chaîne | Statut de l'abonnement |
| Renouveler | Date | Date de renouvellement de l'abonnement |
| cancellationEffectiveDate | Date | Date de prise d'effet de l'annulation |
Membre supprimé
A membre supprimé est déclenché lorsqu'un utilisateur est retiré de la liste des membres.
Informations envoyées dans la charge utile d'un membre supprimé est résumée dans le tableau ci-dessous.
Charge utile
| Propriété | Type | Description |
|---|---|---|
| nom | Chaîne | Le nom du membre supprimé |
| courriel | Chaîne | L'adresse électronique du membre radié |
| ID utilisateur | Chaîne | L'ID utilisateur du membre supprimé |
| Nom de l'événement | Chaîne | Nom de l'événement |
| eventId | Chaîne | L'ID de l'événement |
| l'adhésion | Objet | Cet objet sera inséré dans une charge utile contenant la valeur de l'adhésion. |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description |
|---|---|---|
| identifiant du client (customerId) | Chaîne | Numéro d'identification du membre |
| subscriptionId | Chaîne | ID d'abonnement du membre |
| planId | Chaîne | L'ID du plan auquel l'utilisateur a souscrit |
| statut | Chaîne | Statut de l'abonnement |
| Renouveler | Date | Date de renouvellement de l'abonnement |
| cancellationEffectiveDate | Date | Date à laquelle l'annulation prendra effet |
Abonné ajouté
Un ajouter un abonnement est déclenché lorsqu'un utilisateur achète un plan payant
Informations envoyées dans la charge utile d'un ajouter un abonnement est résumée dans le tableau ci-dessous.
Charge utile
| Propriété | Type | Description |
|---|---|---|
| nom | Chaîne | Le nom du nouvel abonné |
| courriel Chaîne | L'adresse électronique du membre abonné | |
| ID utilisateur | Chaîne | L'ID utilisateur du nouvel abonné |
| Nom de l'événement | Chaîne | Nom de l'événement |
| eventId | Chaîne | L'ID de l'événement |
| l'adhésion | Objet | Cet objet sera inséré dans une charge utile contenant la valeur de l'adhésion. |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description |
|---|---|---|
| identifiant du client (customerId) | Chaîne | Numéro d'identification du client du nouvel abonné |
| subscriptionId | Chaîne | ID d'abonnement du nouvel abonné |
| planId | Chaîne | L'ID du plan auquel l'utilisateur a souscrit |
| statut | Chaîne | Statut de l'abonnement |
| Renouveler | Date | Date de renouvellement de l'abonnement |
| cancellationEffectiveDate | Date | Date à laquelle l'annulation prendra effet |
Abonné mis à jour
Un mise à jour de l'abonnement est déclenché lorsqu'un membre payant passe à un plan gratuit ou passe d'un abonnement annuel à un abonnement mensuel ou vice versa.
Informations envoyées dans la charge utile d'un mise à jour de l'abonnement est résumée dans le tableau ci-dessous
Charge utile
| Propriété | Type | Description |
|---|---|---|
| nom | Chaîne | Le nom de l'abonné qui a mis à jour son plan |
| courriel | Chaîne | L'adresse électronique de l'abonné |
| ID utilisateur | Chaîne | L'ID utilisateur du nouvel abonné |
| Nom de l'événement | Chaîne | Nom de l'événement |
| eventId | Chaîne | L'ID de l'événement |
| l'adhésion | Objet | Cet objet sera inséré dans une charge utile contenant la valeur de l'adhésion. |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description |
|---|---|---|
| identifiant du client (customerId) | Chaîne | |
| subscriptionId | Chaîne ID d'abonnement de l'abonné | |
| planId | Chaîne | L'ID du plan que l'utilisateur a mis à jour. |
| statut | Chaîne | Statut de l'abonnement |
| Renouveler | Date | Date de renouvellement de l'abonnement |
| cancellationEffectiveDate | Date | Date à laquelle l'annulation prendra effet |
Abonnement annulé
Un ajouter un abonnement est déclenché lorsqu'un utilisateur annule son abonnement.
Informations envoyées dans la charge utile d'un ajouter un abonnement est résumée dans le tableau ci-dessous.
Charge utile
| Propriété | Type | Description |
|---|---|---|
| nom | Chaîne | Le nom de l'abonné qui a annulé son plan |
| courriel | Chaîne | L'adresse électronique de l'abonné |
| ID utilisateur | Chaîne | L'identifiant de l'abonné |
| Nom de l'événement | Chaîne | Nom de l'événement |
| eventId | Chaîne | L'ID de l'événement |
| l'adhésion | Objet | Cet objet sera inséré dans une charge utile contenant la valeur de l'adhésion. |
l'adhésion les propriétés de l'objet :
| Propriété | Type | Description |
|---|---|---|
| identifiant du client (customerId) | Chaîne | Numéro d'identification de l'abonné |
| subscriptionId | Chaîne | |
| planId | Chaîne | Il sera mis à jour pour devenir gratuit |
| statut | Chaîne | Statut de l'abonnement |
| Renouveler | Date | |
| cancellationEffectiveDate | Date |
Exemple de code lors de l'ajout d'un membre
{
"name": "Abcd Efgh",
"email": "ilaxvdzrflpbhsrqoi@tmmwj.net",
"user_id": "6391774374eb6d00132cd44e",
"role": "subscriber",
"membership": {
"planId": "FREE",
"status": "INACTIVE",
"customerId": null
},
"eventName": "add-member",
"eventId": "635e21996b8dfb00d3d231d7-PLFKEHEFZ-DCISC"
}Exemple de code lors de la mise à jour d'un membre
{
"name": "Abcd Efgh",
"email": "abcd@abcd.net",
"user_id": "6391774374eb6d00132cd44e",
"role": "subscriber",
"membership": {
"planId": "FREE",
"status": "ACTIVE",
"customerId": null
},
"eventName": "update-member",
"eventId": "635e21996b8dfb00d3d231d7-PLFKEHEFZ-DCISC"
}Exemple de code en cas de suppression d'un membre
{
"email": "sami97abrar@gmail.com",
"user_id": "63956e801a11150011a0057f",
"role": "subscriber",
"membership": {
"planId": "FREE",
"status": "INACTIVE",
"customerId": "cus_Mxdd6rr03JN9JC",
"subscriptionId": null,
"renewAt": null,
"cancellationEffectiveDate": null
},
"eventName": "remove-member",
"eventId": "62c69bb8215fc200b029d395-YKOQ-IAZYYZKMUE"
}Exemple de code lors de l'ajout d'un abonné
{
"name": "Abcd Efgh",
"email": "abcd@abcd.net",
"user_id": "6391774374eb6d00132cd44e",
"role": "subscriber",
"membership": {
"planId": "MONTHLY",
"status": "ACTIVE",
"customerId": null
},
"eventName": "add-subscription",
"eventId": "635e21996b8dfb00d3d231d7-PLFKEHEFZ-DCISC"
}Exemple de code lors de la mise à jour d'un abonnement
{
"name": "Abrar",
"email": "sami97abrar@gmail.com",
"role": "subscriber",
"membership": {
"customerId": "cus_MxeQ8wVzEJJbVY",
"subscriptionId": "sub_1MDj8ERFal0kIVZ7DuIXcACG",
"planId": "price_1Lm9FGRFal0kIVZ7Q9RzMP8E",
"status": "ACTIVE",
"renewAt": 1702276526000,
"cancellationEffectiveDate": null,
},
"user_id": "63956f7c1a11150011a00584",
"eventName": "update-subscription",
"eventId": "62c69bb8215fc200b029d395-EUNLSJKW-LWWJQE"
}Exemple de code en cas d'annulation d'un abonnement
{
"name": "Abrar",
"email": "sami97abrar@gmail.com",
"role": "subscriber",
"membership": {
"customerId": "cus_MxeQ8wVzEJJbVY",
"subscriptionId": "sub_1MDj8ERFal0kIVZ7DuIXcACG",
"planId": "price_1Lm9FGRFal0kIVZ7Q9RzMP8E",
"status": "CANCELLED",
"renewAt": "2023-12-11T06:35:26.000Z",
"cancellationEffectiveDate": 1702276526000,
},
"user_id": "63956f7c1a11150011a00584",
"eventName": "cancel-subscription",
"eventId": "62c69bb8215fc200b029d395-QBLNYSZF-KTXYAY"
}RArticles connexes
Adding Webhook for Membership Events
Mis à jour le : 28/10/2023
Merci !