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.

{
  "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"
    }
  }
}

Événements de collecte de fonds

Événements : fundraiser_created, fundraiser_updated

object

Détails de la collecte de fonds.

Afficher propriétés

integer

ID de la collecte de fonds.

integer

ID du partenaire.

string

Nom de la collecte de fonds.

string

Description de la collecte de fonds.

string

URL de la collecte de fonds.

number

Objectif financier de la collecte de fonds.

number

Montant recueilli par la collecte de fonds.

number

Montant des dons hors ligne en attente.

number

Montant des dons jumelés de la collecte de fonds.

integer

Nombre de donateurs.

string

Date et heure de début de la collecte de fonds.

string

Date et heure de fin de la collecte de fonds.

string

Langue de la collecte de fonds.

array

Étiquettes de la collecte de fonds.

string

Date et heure de création de la collecte de fonds.

object

Propriétaire de la collecte de fonds.

object | null

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

object

Inclus dans les événements fundraiser_updated.

Événements de transaction

Événements : transaction_created

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.

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.

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.

object[]

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

Événements d’équipe

Événements : fundraiser_team_created, fundraiser_team_updated

object

Détails de l’équipe.

Afficher propriétés

integer

ID de l’équipe.

string

Nom de l’équipe.

string

URL de l’équipe.

number

Objectif financier de l’équipe.

number

Montant recueilli par l’équipe.

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.

string

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

string

Langue de l’équipe.

object

Données des champs personnalisés de l’équipe.

object

Propriétaire de l’équipe.

object

Résumé de la collecte de fonds.

object

Inclus dans les événements fundraiser_team_updated.

Événements de page personnelle

Événements : fundraiser_page_created, fundraiser_page_updated

object

Détails de la page personnelle.

Afficher propriétés

integer

ID de la page personnelle.

string

Nom de la page personnelle.

string

URL de la page personnelle.

number

Objectif financier de la page personnelle.

number

Montant recueilli par la page personnelle.

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.

string

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

string

Langue de la page personnelle.

object

Données des champs personnalisés de la page personnelle.

object

Propriétaire de la page personnelle.

object

Résumé de la collecte de fonds.

object | null

Résumé de l’équipe lorsque la page appartient à une équipe.

object

Inclus dans les événements fundraiser_page_updated.

É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

Événements de collecte de fonds

Événements de transaction

É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

​Événements de collecte de fonds

​Événements de transaction

​É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

Événements de collecte de fonds

Événements de transaction

Événements d’équipe

Événements de page personnelle

Événements de reçu fiscal

Événements de jalon