Charges utiles des événements

CrowdChange envoie les livraisons de webhook au format JSON avec un nom d’événement dans event et des données propres à l’événement dans data. Le même objet est enregistré dans le champ payload des journaux de webhook. Les événements sont livrés aux webhooks abonnés du partenaire de la collecte de fonds et, le cas échéant, de son partenaire parent distinct.

{
  "event": "transaction_created",
  "data": {}
}

Modifications des événements de mise à jour

Les événements fundraiser_updated, fundraiser_team_updated et fundraiser_page_updated incluent un objet changes dans data.

object

Champs modifiés indexés selon la notation pointée. Chaque champ modifié contient les valeurs old et new.

{
  "changes": {
    "name": {
      "old": "Ancien nom de la collecte de fonds",
      "new": "Nouveau nom de la collecte de fonds"
    }
  }
}

Détails des événements de suppression

Les événements fundraiser_deleted, fundraiser_team_deleted et fundraiser_page_deleted incluent les champs habituels de l’entité supprimée ainsi que deleted_at au format YYYY-MM-DD HH:mm:ss. Si la suppression d’une équipe supprime aussi ses pages personnelles, chaque page supprimée produit un événement fundraiser_page_deleted. Les pages déplacées vers la collecte de fonds restent actives et ne produisent pas d’événement de suppression. Cet exemple montre uniquement les champs liés à la suppression; les autres champs de la collecte de fonds sont décrits ci-dessous.

{
  "event": "fundraiser_deleted",
  "data": {
    "id": 1001,
    "deleted_at": "2026-10-07 16:00:03"
  }
}

Événements de collecte de fonds

Événements : fundraiser_created, fundraiser_updated, fundraiser_deleted

object

Détails de la collecte de fonds.

Afficher properties

integer

ID de la campagne.

integer

ID du site.

string

Nom de la campagne.

string | null

Description de la campagne.

string | null

URL complète de la campagne.

number

Montant de l’objectif.

string

Montant de l’objectif formaté avec le symbole de devise.

number

Montant amassé par la campagne.

string

Montant amassé formaté avec le symbole de devise.

string

Type d’objectif de la campagne.

number

Montant des dons hors ligne en attente attribué à la campagne.

number

Montant du jumelage de dons attribué directement à la campagne.

integer

Nombre de donateurs.

integer

Nombre d’équipes dans la campagne.

integer

Nombre de pages personnelles dans la campagne.

object

Afficher propriétés

string

URL de l’image originale de la campagne.

string | null

ID de l’image de la campagne.

string | null

Date et heure de début de la campagne.

string | null

Date et heure de fin de la campagne.

string

Langue de la campagne. Valeurs permises : en, fr.

any[]

Étiquettes de la campagne.

object[]

Questions et réponses personnalisées configurées pour la ressource.

Afficher propriétés

integer

ID du champ personnalisé.

integer | null

ID du champ source lorsque le champ a été copié depuis un modèle.

string

Libellé du champ personnalisé.

string | null

Réponse formatée au champ personnalisé.

string | null

ID personnalisé du champ.

string | null

ID personnalisé de la réponse sélectionnée, le cas échéant.

string | null

Date et heure de création de la campagne.

object

Propriétaire de la campagne.

Afficher propriétés

integer

ID de l’utilisateur.

string

Nom de l’utilisateur.

string

Courriel de l’utilisateur.

string

Courriel de contact de l’utilisateur.

string

Prénom de l’utilisateur.

string

Nom de famille de l’utilisateur.

string

Titre de l’utilisateur.

object | null

Organisation de la campagne, le cas échéant.

Afficher propriétés

integer

ID de l’organisation.

string

Nom de l’organisation.

string

ID personnalisé de l’organisation.

string | null

Date et heure de fermeture de la campagne.

boolean

Indique si la campagne est masquée.

object | null

Résumé du modèle de campagne, le cas échéant.

Afficher propriétés

integer

ID du modèle.

string

Nom du modèle.

object

Inclus dans les événements fundraiser_updated.

string | null

Inclus dans les événements fundraiser_deleted. Date et heure de suppression au format YYYY-MM-DD HH:mm:ss.

Événements de transaction

Événements : transaction_created, transaction_refunded

object

Détails de la transaction.

Afficher propriétés

integer

ID de la transaction.

string

ID de référence de la transaction.

number

Montant total de la transaction. Pour une transaction de remboursement, il s’agit du montant de ce remboursement. Un montant d’argent remboursé est négatif; un retour sans mouvement d’argent, comme le retour d’un don jumelé uniquement, peut avoir un montant de zéro.

string

Devise de la transaction.

string

Symbole de la devise de la transaction.

string

Fréquence du don.

integer

ID de la collecte de fonds.

integer | null

ID de la transaction parente, le cas échéant. Pour un remboursement, il s’agit de l’ID du paiement d’origine.

integer | null

ID de la page personnelle, le cas échéant.

integer | null

ID de l’équipe, le cas échéant.

integer | null

ID de l’organisation, le cas échéant.

string

Nom de la collecte de fonds.

string | null

Nom de l’organisation, le cas échéant.

string | null

ID personnalisé de l’organisation, le cas échéant.

integer

ID de l’utilisateur donateur.

string

Adresse courriel du donateur.

object | null

Adresse postale lorsqu’un reçu est envoyé par la poste.

string | null

Libellé de la transaction sur le relevé de paiement.

object

Répartition du montant de la transaction.

object | null

Détails de l’offre incitative, le cas échéant.

Code promotionnel appliqué, le cas échéant.

object | null

Adresse de facturation.

object | null

Données de dédicace ou d’hommage, le cas échéant.

string

Date et heure de création de la transaction.

string

Statut de la transaction. Les transactions de remboursement utilisent refunded.

boolean

Indique si CrowdChange a marqué cette transaction comme entièrement remboursée. Utilisez status pour reconnaître une transaction de remboursement.

object

Inclus uniquement lorsque status vaut refunded et que parent_id est défini. Contient le paiement d’origine avec les mêmes champs de transaction. Son id correspond à parent_id.

object[]

Billets attribués, le cas échéant.

Remboursements complets et partiels

transaction_refunded est envoyé lorsqu’une transaction de remboursement est créée dans CrowdChange, pour les remboursements complets et partiels. Chaque remboursement possède son propre data.id. Les remboursements partiels successifs partagent le parent_id du paiement d’origine; data.amount représente uniquement le remboursement courant, et non le montant remboursé cumulatif. data.parent conserve le montant et le statut du paiement d’origine. Son champ is_refunded expose l’indicateur de remboursement complet enregistré dans CrowdChange. Un remboursement partiel peut avoir data.status: "refunded" alors que data.parent.is_refunded vaut false. La charge utile ne calcule pas le solde restant. Le traitement habituel des remboursements émet aussi l’événement existant transaction_created pour la même transaction de remboursement, avec parent. Si vous êtes abonné aux deux événements, utilisez le data.id du remboursement pour éviter de compter deux fois le même remboursement. Ces exemples distincts montrent uniquement les champs liés aux remboursements. data et data.parent incluent aussi les autres champs de transaction ci-dessus.

{
  "event": "transaction_refunded",
  "data": {
    "id": 6002,
    "amount": -100,
    "parent_id": 6001,
    "status": "refunded",
    "is_refunded": false,
    "parent": {
      "id": 6001,
      "amount": 100,
      "parent_id": null,
      "status": "completed",
      "is_refunded": true
    }
  }
}

{
  "event": "transaction_refunded",
  "data": {
    "id": 6003,
    "amount": -25,
    "parent_id": 6001,
    "status": "refunded",
    "is_refunded": false,
    "parent": {
      "id": 6001,
      "amount": 100,
      "parent_id": null,
      "status": "completed",
      "is_refunded": false
    }
  }
}

Événements d’équipe

Événements : fundraiser_team_created, fundraiser_team_updated, fundraiser_team_deleted

object

Détails de l’équipe.

Afficher properties

integer

ID de l’équipe.

object | null

Super équipe sélectionnée, ou null si elle n’est pas disponible.

Afficher propriétés

integer

ID de la super équipe.

string

Nom de la super équipe.

object[]

Questions configurées et toutes leurs réponses actuelles, même inchangées. Tableau vide pour les pages personnelles rattachées à une équipe ou si les super équipes sont désactivées.

Afficher propriétés

integer

ID de la question.

string

Libellé de la question dans la langue de la réponse.

string

Type de question.

string | null

Sous-type de texte, le cas échéant.

object[]

Réponses à cette question; [] si aucune. Les sélections multiples contiennent une entrée par option.

Afficher propriétés

string | null

Valeur enregistrée du texte ou du consentement; null pour les options.

integer | null

ID de l’option sélectionnée, le cas échéant.

string | null

Texte lisible, libellé de l’option ou réponse de consentement.

string

Nom de l’équipe.

string

Type d’équipe.

string | null

URL de la page de l’équipe.

number

Montant de l’objectif.

string

Montant de l’objectif formaté avec le symbole de devise.

number

Montant amassé par l’équipe.

string

Montant amassé formaté avec le symbole de devise.

number

Montant des dons hors ligne en attente pour l’équipe.

number

Montant des dons jumelés de l’équipe.

integer

Nombre de donateurs de l’équipe.

integer

Nombre de pages personnelles de l’équipe.

object

Afficher propriétés

string

URL de l’image originale de l’équipe.

string | null

ID de l’image de l’équipe.

string | null

Description de l’équipe.

boolean

Indique si l’image de l’équipe est héritée de la campagne.

boolean

Indique si la description de l’équipe est héritée de la campagne.

string | null

Date et heure de création de l’équipe.

string

Langue de l’équipe. Valeurs permises : en, fr.

object[]

Questions et réponses personnalisées configurées pour la ressource.

Afficher propriétés

integer

ID du champ personnalisé.

integer | null

ID du champ source lorsque le champ a été copié depuis un modèle.

string

Libellé du champ personnalisé.

string | null

Réponse formatée au champ personnalisé.

string | null

ID personnalisé du champ.

string | null

ID personnalisé de la réponse sélectionnée, le cas échéant.

object

Propriétaire de l’équipe.

Afficher propriétés

integer

ID de l’utilisateur.

string

Nom de l’utilisateur.

string

Courriel de l’utilisateur.

string

Courriel de contact de l’utilisateur.

string

Prénom de l’utilisateur.

string

Nom de famille de l’utilisateur.

string

Titre de l’utilisateur.

object

Résumé de la campagne.

Afficher propriétés

integer

ID de la campagne.

string

Nom de la campagne.

string | null

URL de la campagne.

number

Montant de l’objectif de la campagne.

number

Montant total amassé par la campagne.

string

Montant amassé de la campagne, formaté.

string

Langue de la campagne.

any[]

Étiquettes de la campagne.

object | null

Organisation de la campagne, le cas échéant.

object

Inclus dans les événements fundraiser_team_updated.

string | null

Inclus dans les événements fundraiser_team_deleted. Date et heure de suppression au format YYYY-MM-DD HH:mm:ss.

Événements de page personnelle

Événements : fundraiser_page_created, fundraiser_page_updated, fundraiser_page_deleted

object

Détails de la page personnelle.

Afficher properties

integer

ID de la page personnelle.

object | null

Super équipe sélectionnée, ou null si elle n’est pas disponible.

Afficher propriétés

integer

ID de la super équipe.

string

Nom de la super équipe.

object[]

Questions configurées et toutes leurs réponses actuelles, même inchangées. Tableau vide pour les pages personnelles rattachées à une équipe ou si les super équipes sont désactivées.

Afficher propriétés

integer

ID de la question.

string

Libellé de la question dans la langue de la réponse.

string

Type de question.

string | null

Sous-type de texte, le cas échéant.

object[]

Réponses à cette question; [] si aucune. Les sélections multiples contiennent une entrée par option.

Afficher propriétés

string | null

Valeur enregistrée du texte ou du consentement; null pour les options.

integer | null

ID de l’option sélectionnée, le cas échéant.

string | null

Texte lisible, libellé de l’option ou réponse de consentement.

string

Nom de la page personnelle.

string

Type de page personnelle.

string | null

URL de la page personnelle.

number

Montant de l’objectif.

string

Montant de l’objectif formaté avec le symbole de devise.

number

Montant amassé par la page personnelle.

string

Montant amassé formaté avec le symbole de devise.

number

Montant des dons hors ligne en attente pour la page personnelle.

number

Montant des dons jumelés de la page personnelle.

integer

Nombre de donateurs de la page personnelle.

object

Afficher propriétés

string

URL de l’image originale de la page personnelle.

string | null

ID de l’image de la page personnelle.

string | null

Description de la page personnelle.

boolean

Indique si l’image de la page personnelle est héritée de la campagne.

boolean

Indique si la description de la page personnelle est héritée de la campagne.

object | null

Détails de l’inscrivant, le cas échéant.

Afficher propriétés

string

Prénom de l’inscrivant.

string

Nom de famille de l’inscrivant.

string | null

Date et heure d’archivage de la page personnelle.

string | null

Date et heure de fermeture de la page personnelle.

string | null

Date et heure de création de la page personnelle.

string

Langue de la page personnelle. Valeurs permises : en, fr.

object[]

Questions et réponses personnalisées configurées pour la ressource.

Afficher propriétés

integer

ID du champ personnalisé.

integer | null

ID du champ source lorsque le champ a été copié depuis un modèle.

string

Libellé du champ personnalisé.

string | null

Réponse formatée au champ personnalisé.

string | null

ID personnalisé du champ.

string | null

ID personnalisé de la réponse sélectionnée, le cas échéant.

object

Propriétaire de la page personnelle.

Afficher propriétés

integer

ID de l’utilisateur.

string

Nom de l’utilisateur.

string

Courriel de l’utilisateur.

string

Courriel de contact de l’utilisateur.

string

Prénom de l’utilisateur.

string

Nom de famille de l’utilisateur.

string

Titre de l’utilisateur.

object

Résumé de la campagne.

Afficher propriétés

integer

ID de la campagne.

string

Nom de la campagne.

string | null

URL de la campagne.

number

Montant de l’objectif de la campagne.

number

Montant total amassé par la campagne.

string

Montant amassé de la campagne, formaté.

string

Langue de la campagne.

any[]

Étiquettes de la campagne.

object | null

Organisation de la campagne, le cas échéant.

object | null

Résumé de l’équipe lorsque la page personnelle lui appartient.

Afficher propriétés

integer

ID de l’équipe.

string

Nom de l’équipe.

string | null

URL de la page de l’équipe.

number

Montant de l’objectif de l’équipe.

string

Montant de l’objectif de l’équipe, formaté.

number

Montant total amassé par l’équipe.

string

Montant amassé de l’équipe, formaté.

string

Langue de l’équipe.

object

Inclus dans les événements fundraiser_page_updated.

string | null

Inclus dans les événements fundraiser_page_deleted. Date et heure de suppression au format YYYY-MM-DD HH:mm:ss.

Événements de reçu fiscal

Événements : tax_receipt_issued

object

Détails du reçu fiscal.

Afficher propriétés

integer

ID du reçu fiscal.

integer

ID de la transaction.

number

Montant du don.

number

Montant de l’avantage.

number

Montant admissible aux fins fiscales.

string | null

Nom de l’entreprise, le cas échéant.

string

Nom imprimé sur le reçu.

string

Date et heure d’émission du reçu.

string

Numéro du reçu.

string

Statut du reçu. Les valeurs possibles sont valid et cancelled.

string

Prénom du destinataire.

string

Nom de famille du destinataire.

string | null

Titre du destinataire.

string

Adresse courriel du destinataire.

string

Adresse municipale du destinataire.

string

État ou province du destinataire.

string

Pays du destinataire.

string

Code postal du destinataire.

string

Ville du destinataire.

Événements de jalon

Événements : milestone_triggered Envoyé lorsqu’une notification de jalon est déclenchée pour le destinataire d’origine. Les adresses courriel de destinataires supplémentaires configurées pour le jalon ne sont pas incluses dans la charge utile du webhook.

object

Détails du jalon.

Afficher propriétés

integer

ID du journal du jalon.

integer

ID du modèle de courriel.

string

Nom du modèle de courriel.

string

Type du modèle de courriel.

string

Identifiant du déclencheur de jalon.

string

Groupe de destinataires du déclencheur.

string

Type de valeur du déclencheur, comme amount ou percent.

string

Valeur configurée du déclencheur de jalon.

object

Données supplémentaires du déclencheur. Les adresses courriel de destinataires supplémentaires sont exclues.

string

Date et heure de mise en file d’attente de la notification.

object

Destinataire initial de la notification de jalon.

object

Résumé de la collecte de fonds.

object | null

Équipe ayant atteint le jalon, le cas échéant.

object | null

Page personnelle ayant atteint le jalon, le cas échéant.

Introduction

API côté serveur

API côté client

Charges utiles des événements

Modifications des événements de mise à jour

Détails des événements de suppression

Événements de collecte de fonds

Événements de transaction

Remboursements complets et partiels

Événements d’équipe

Événements de page personnelle

Événements de reçu fiscal

Événements de jalon

​Modifications des événements de mise à jour

​Détails des événements de suppression

​Événements de collecte de fonds

​Événements de transaction

​Remboursements complets et partiels

​Événements d’équipe

​Événements de page personnelle

​Événements de reçu fiscal

​Événements de jalon

Modifications des événements de mise à jour

Détails des événements de suppression

Événements de collecte de fonds

Événements de transaction

Remboursements complets et partiels

Événements d’équipe

Événements de page personnelle

Événements de reçu fiscal

Événements de jalon