Documentation Charitable

Apprenez à tirer le meilleur parti de Charitable grâce à des instructions claires, étape par étape.

Automation Connect 2.0

Automation Connect transforme chaque don, événement de campagne ou soumission de formulaire en un déclencheur en temps réel qui envoie des données à n'importe quelle application ou service via des webhooks. Connectez Charitable avec Zapier, Make.com, Slack, HubSpot, Mailchimp, n8n, Pabbly Connect et des milliers d'autres plateformes – aucun développeur requis.

Prérequis : plan Pro/Elite et Charitable Pro 1.8.13+.

Note : Si vous utilisez Charitable Automation 1.x, la documentation est disponible ici.


Fonctionnalités clés (par rapport à la version 1.x)

  • Déclenchez des webhooks sur 17 événements de don, de campagne et de don récurrent
  • Filtrez les envois avec une logique conditionnelle sur 11 champs de critères (donateur, don, campagne, données du formulaire)
  • Personnalisez la charge utile avec plus de 80 champs de données disponibles couvrant les détails du donateur, de la campagne, du don et de la passerelle
  • Signez chaque requête sortante avec HMAC-SHA256 pour la sécurité des points de terminaison
  • Envoyez des charges utiles de test et inspectez les réponses d'envoi directement depuis l'éditeur
  • Démarrez rapidement avec 8 modèles de plateforme pré-construits (Zapier, Make.com, Slack, HubSpot, Mailchimp, n8n, Pabbly Connect et une toile vierge)
  • Réessayez automatiquement les envois échoués via WordPress Action Scheduler
  • Gérez tous les abonnements depuis un tableau de bord central dans l'administration Charitable

Pourquoi utiliser Automation Connect ?

Charitable Automation Connect remplace la saisie manuelle des données et les intégrations personnalisées ponctuelles par un système de webhook unique et flexible. Au lieu d'écrire du code personnalisé chaque fois que vous souhaitez synchroniser les enregistrements des donateurs, notifier un canal Slack ou ajouter des contacts à un CRM, vous configurez un abonnement une fois et il s'exécute automatiquement à chaque événement correspondant.


Voyez-le en action


Exigences

  • Charitable Pro 1.8.13 ou ultérieur
  • Licence Charitable Pro active (plan Pro ou supérieur)
  • WordPress 6.2 ou ultérieure
  • PHP 7.4 ou version ultérieure

Démarrage

Installation et Activation

  1. Connectez-vous à votre tableau de bord WordPress et allez dans Charitable > Extensions.
  2. Localisez Automation Connect et cliquez sur Activer.
  3. Une fois actif, un nouvel élément Automation apparaît dans le menu d'administration Charitable.

Création de votre premier abonnement

  1. Allez dans Charitable > Automation dans wp-admin.
  2. Cliquez sur + Ajouter un nouvel abonnement.
  3. Sélectionnez un modèle de plateforme ou choisissez Démarrer à partir de zéro.
  4. Configurez l'abonnement dans l'éditeur (voir Utilisation ci-dessous).
  5. Cliquez sur Enregistrer pour activer l'abonnement.

Utilisation

Éditeur d'abonnement

Chaque abonnement est configuré dans quatre onglets :

Onglet de base

Définissez le nom de l'abonnement, l'URL du webhook cible et l'événement déclencheur.

Événements disponibles — Dons

ÉvénementDescription
don_creeUn nouveau don est soumis
don_completeUn don atteint le statut Terminé
don_annuleUn don est annulé
don_echoueLe paiement d'un don échoue
don_rembourseUn don est remboursé
don_en_attenteUn don est défini comme En attente
don_preapprouveUn don est pré-approuvé

Événements disponibles — Campagnes

ÉvénementDescription
camp_creeUne nouvelle campagne est publiée
camp_majUne campagne existante est mise à jour
camp_termineUne campagne atteint sa date de fin
camp_objectif_atteintUne campagne atteint son objectif de collecte de fonds

Événements disponibles — Dons récurrents

ÉvénementDescription
recu_creeUn nouveau plan récurrent est créé
recu_completeUn paiement récurrent est complété
recu_annuleUn plan récurrent est annulé
recu_echoueUn paiement récurrent échoue
recu_mis_en_pauseUn plan récurrent est mis en pause
recu_repriseUn plan mis en pause reprend

Onglet Conditions

Ajoutez des règles pour contrôler quand le webhook se déclenche. Toutes les règles d'un groupe utilisent la logique ET ; plusieurs groupes utilisent la logique OU.

Champs de condition disponibles

ChampOpérateurs
montant_donest, estpas, supérieurà, inférieur_à
etat_donest, est_pas
id_campagneest, est_pas
categorie_campest, est_pas
passerelle_paiementest, est_pas
pays_donateurest, est_pas
email_donateurest, est_pas, contient
optin_newsletterest (oui/non)
type_donest (ponctuel, récurrent)
periode_recuest, est_pas
champ_personnaliseest, est_pas, contient

Onglet Payload

Choisissez exactement quels champs inclure dans la charge utile JSON sortante. Décochez les champs dont vous n'avez pas besoin pour maintenir des charges utiles légères.

Champs du donateur (exemple)

id_donateurnom_donateurprenom_donateurnom_famille_donateuremail_donateurtelephone_donateuradresse_donateurville_donateuretat_donateurcode_postal_donateurpays_donateurtotal_donne_donateurnombre_dons_donateur

Champs de dons (exemple)

id_donmontant_donetat_dondate_donheure_dondevise_donpasserelle_donid_transaction_passerelle_donnotes_dontype_donids_campnoms_camp

Champs de campagne (exemple)

campaign_id, campaign_title, campaign_url, campaign_goal, campaign_donated, campaign_percent_raised, campaign_donor_count, campaign_start_date, campaign_end_date, campaign_categories

Champs récurrents (exemple)

recurring_id, recurring_amount, recurring_period, recurring_frequency, recurring_start_date, recurring_status

Champs du site/méta (exemple)

site_url, site_name, event_type, delivery_timestamp, webhook_id

Onglet Test / Débogage

Envoyez une charge utile de test en utilisant des données réelles ou d'exemple et inspectez le code d'état de la réponse HTTP, le corps de la réponse et le délai de livraison. Cela vous permet de vérifier que votre point de terminaison reçoit des données avant la mise en production.


Modèles de plateforme

Lors de la création d'un nouvel abonnement, vous pouvez partir de l'un des huit modèles prédéfinis. Chaque modèle pré-remplit le déclencheur d'événement et, le cas échéant, ajoute des conditions par défaut raisonnables.

ModèleÉvénement par défautRemarques
Zapierdon_creePréconfiguré pour Webhooks by Zapier Catch Hook
Make.comdon_creePréconfiguré pour le module Webhook personnalisé
n8ndon_creePréconfiguré pour le nœud Webhook n8n
Pabbly Connectdon_creePréconfiguré pour le déclencheur webhook Pabbly
HubSpotdon_creePréconfiguré pour le webhook du workflow HubSpot
Mailchimpdon_creeAjoute une condition d'opt-in à la newsletter par défaut
Slackdon_creePréconfiguré pour les Webhooks entrants Slack
Commencer à partir de zéro(aucun)Contrôle total sur tous les paramètres

Livraison de webhook

Format de la requête

Les webhooks sont livrés sous forme de requêtes HTTP POST avec un corps JSON et les en-têtes suivants :

En-têteValeur
Content-Typeapplication/json
X-WP-Webhook-SignatureSignature HMAC-SHA256
X-WP-Webhook-EventClé d'événement (par ex. donation_created)
X-WP-Webhook-IDID de l'article de l'abonnement

Vérification de la signature

Chaque requête inclut un en-tête X-WP-Webhook-Signature. La signature est un HMAC-SHA256 hexadécimal en minuscules du corps de la charge utile JSON brute, indexé avec la clé secrète de l'abonnement.

Pour vérifier en PHP :

$signature = hash_hmac( 'sha256', $raw_body, $secret_key );
$is_valid   = hash_equals( $signature, $received_signature );

Comportement de nouvelle tentative

Les livraisons échouées (réponses non 2xx ou erreurs de connexion) sont retentées automatiquement à l'aide de l'Action Scheduler de WordPress. Le calendrier de nouvelle tentative utilise une exponentielle de décélération. Après le nombre maximum de nouvelles tentatives, la livraison est marquée comme définitivement échouée et enregistrée.


Personnalisation

CSS

L'interface d'administration d'Automation Connect hérite des styles d'administration standard de Charitable et WordPress. Aucun CSS frontal n'est généré.

Remplacement de modèles

Automation Connect n'a pas de modèles publics. Toutes les sorties sont des charges utiles JSON livrées côté serveur.


Dépannage

Le webhook n'est pas livré

Vérifiez les points suivants dans l'ordre : 1. Confirmez que l'abonnement est enregistré et que le type d'événement correspond à ce que vous attendez (par ex. donation_completed, pas donation_created). 2. Vérifiez que l'URL du webhook est accessible publiquement — les URL localhost locales ne fonctionneront pas depuis un serveur en direct. 3. Vérifiez dans Charitable > Outils > Journaux les erreurs de livraison, en filtrant par source charitable-automation-connect.

La charge utile de test a été envoyée avec succès mais les événements en direct ne se déclenchent pas

Les conditions peuvent filtrer les événements en direct. Ouvrez l'onglet Conditions et examinez chaque règle. Désactivez temporairement toutes les conditions pour confirmer que le webhook se déclenche, puis réajoutez les conditions une par une.

Des champs de charge utile sont manquants dans le JSON

Décochez et recochez les champs pertinents dans l'onglet Charge utile, puis enregistrez. Les champs ajoutés à Charitable via des plugins tiers peuvent nécessiter d'être enregistrés à l'aide du filtre charitable_automation_connect_payload_fields (voir Ressources pour les développeurs).

Un avis de licence apparaît dans l'administration

Automation Connect 2.0 nécessite une licence Charitable Pro active au niveau du plan Pro ou supérieur. Si vous voyez un avis de licence, vérifiez que votre licence est active dans Charitable > Paramètres > Licences et que votre plan est Pro ou supérieur.


Ressources pour les développeurs

Accroches et filtres

Charge utile

  • charitable_automation_connect_payload_fields — Filtre la liste des champs de charge utile disponibles. Utilisez ceci pour ajouter des champs personnalisés de votre plugin ou thème.
  • charitable_automation_connect_payload — Filtre le tableau de charge utile avant la livraison. Reçoit $payload, $subscription_id, $event.

Événements

  • charitable_automation_connect_events — Filtre la liste des événements de déclenchement disponibles. Ajoutez ou supprimez des définitions d'événements.
  • charitable_automation_connect_before_deliver — Se déclenche avant l'envoi d'un webhook. Reçoit $subscription_id, $event, $payload.
  • charitable_automation_connect_after_deliver — Se déclenche après l’envoi d’un webhook. Reçoit $subscription_id$response$payload.

Conditions

  • charitable_automation_connect_condition_fields — Filtre les champs de condition disponibles. Utilisez ceci pour enregistrer des critères de condition personnalisés.

Modèles

  • charitable_automation_connect_templates — Filtre la liste des modèles de plateforme affichés dans le sélecteur de modèles. Ajoutez des modèles préconfigurés personnalisés.

Licence / Livraison

  • charitable_automation_connect_delivery_blocked — Filtre si la livraison est bloquée. Retournez false pour autoriser la livraison quel que soit l’état de la licence (utile pour les tests).

Fonctions utiles

  • charitable_automation_connect() — Retourne l’instance principale du plugin.
  • charitable_automation_connect()->get( 'subscriptions' ) — Retourne l’instance SubscriptionsRepository pour interroger les abonnements actifs.

Ajout de champs de charge utile personnalisés

add_filter( 'charitable_automation_connect_payload_fields', function( $fields ) {
    $fields['my_custom_field'] = array(
        'label'   => __( 'My Custom Field', 'my-plugin' ),
        'group'   => 'donor',
        'resolve' => function( $event_data ) {
            return get_user_meta( $event_data['donor_user_id'], 'my_meta_key', true );
        },
    );
    return $fields;
} );

Ajout d’événements personnalisés

add_filter( 'charitable_automation_connect_events', function( $events ) {
    $events['my_custom_event'] = array(
        'label'       => __( 'My Custom Event', 'my-plugin' ),
        'group'       => 'donations',
        'description' => __( 'Fires when my custom condition occurs.', 'my-plugin' ),
    );
    return $events;
} );

Ressources supplémentaires

Vous avez encore des questions ? Nous sommes là pour vous aider !

Dernière modification :

Quoi de neuf dans Charitable

Voir les dernières mises à jour
🔔 Abonnez-vous pour recevoir nos dernières mises à jour
📧 Abonnez-vous aux e-mails

Abonnement par e-mail

Rejoignez notre newsletter

Nous ne vous enverrons pas de spam. Nous envoyons un e-mail uniquement lorsque nous pensons qu'il vous sera réellement utile. Désabonnez-vous à tout moment !

Nouveau modèles

🤩 Nouveaux modèles de campagne Beacon avec bloc « Héros » !

Avec les nouveaux modèles de campagne Beacon pour Charitable Pro, vous pouvez lancer une page de collecte de fonds époustouflante sur toute la largeur qui capte instantanément l’attention des visiteurs au-dessus de la ligne de flottaison.

En-tête de la page de collecte de fonds pour Sauver le parc Maple Grove avec un widget de don et une petite photo carrée d'une miniature d'arbre ensoleillé à gauche.

🔦 Impact au-dessus de la ligne de flottaison : commencez avec une image principale sur toute la largeur, votre logo et votre objectif avec un widget de don directement sur la bannière afin que votre demande et votre élan soient enregistrés instantanément sans faire défiler.

📐 Deux mises en page flexibles : choisissez entre une mise en page structurée à deux colonnes pour le récit côte à côte et les détails de support, ou une vue épurée à une colonne conçue pour des récits longs et ininterrompus.

⚡ Champ Héros tout-en-un : alimenté par le nouveau champ Héros de campagne, réunissant les médias d’arrière-plan, les barres de progression en direct, les montants de don personnalisés et les onglets de dons récurrents dans un seul bloc cohérent qui peut être intégré dans n’importe quelle mise en page.

🎨 Correspondance automatique des thèmes : la bannière principale et le widget de don héritent automatiquement des couleurs de bouton et d’accent de votre thème de campagne, garantissant que l’ensemble de votre présentation reste magnifiquement fidèle à la marque sans toucher une ligne de CSS.

En savoir plus ici.

formulaire de don Fonctionnalité Nouveau

📝 Bloc de formulaire de don : Intégrez un formulaire de don fonctionnel n'importe où

Avec le nouveau bloc de formulaire de don pour Charitable Pro, vous pouvez placer un formulaire de don entièrement fonctionnel directement sur n'importe quelle page ou publication dans l'éditeur de blocs WordPress. Pas de redirections, pas de rechargements de page, et zéro friction entre la lecture de votre histoire et la contribution.

📝 Placez des formulaires n'importe où : Placez un formulaire fonctionnel directement sur votre page d'accueil, à l'intérieur d'une publication de blog axée sur l'histoire, sur une page de destination dédiée, ou dans une annonce de campagne.

🎯 Liaison dynamique de campagne : Choisissez facilement une campagne spécifique dans la barre latérale du bloc ou définissez-la pour qu'elle se lie automatiquement à la campagne en cours de visualisation.

📐 Vues de formulaire complètes vs minimales : Basculez entre une mise en page complète ou une vue minimale compacte pour s'adapter parfaitement aux barres latérales, aux colonnes étroites ou aux larges pages de destination.

🎨 Styles sans code ciblés : Personnalisez la typographie, l'espacement des conteneurs, le rayon des bordures, les boutons de montant et les couleurs d'accent indépendamment pour chaque instance de formulaire sans toucher une ligne de CSS.

En savoir plus ici.

ambassadeurs Nouveau

👤 Profils des créateurs : Mettez un visage derrière chaque campagne pair-à-pair

Ambassadors 3.3.0 propose désormais des profils de créateurs, offrant à vos supporters un espace public permanent et partageable qui transforme les collecteurs de fonds ponctuels en relations durables.

👤 Pages publiques des créateurs : Donnez à chaque collecteur de fonds une page de destination instantanée et soignée sur /creator/leur-nom/ pour présenter leur avatar personnalisé, leur biographie et une grille consultable de leurs campagnes.

📊 Preuve d'impact : Renforcez la confiance des donateurs en affichant les jalons de l'ensemble du site sur le profil, tels que le montant total collecté et le nombre total de donateurs.

💳 Cartes interactives au survol : Lorsque les donateurs survolent le nom d'un créateur sur une page de campagne, une carte compacte s'affiche avec sa biographie et ses identifiants sociaux au moment de la décision.

📍 Partage responsable de la localisation : Permettez aux créateurs d'indiquer en toute sécurité où se trouvent leurs supporters locaux en utilisant uniquement les détails de la ville, de l'État et du pays.

🛠️ Personnalisation en libre-service : Les collecteurs de fonds peuvent mettre à jour leurs propres profils et lier jusqu'à six réseaux sociaux directement depuis le hub Mes campagnes, ce qui vous fait gagner du temps d'administration.

Prêt à responsabiliser vos défenseurs ? Mettez à jour vers Ambassadors 3.3.0 et activez "Activer la page publique du créateur" dès aujourd'hui !

Amélioration Paiements

📱 Transformez les utilisateurs mobiles en donateurs : Découvrez la mise à niveau Mollie de Charitable

Vous perdez des supporters mobiles parce qu'ils détestent taper de longs numéros de carte sur leur téléphone ? L'intégration Mollie mise à jour de Charitable propose :

⚡ Paiement instantané via portefeuille : Permettez aux donateurs d'effectuer leurs dons instantanément en utilisant Apple Pay ou Google Pay avec une simple analyse faciale, une empreinte digitale ou un toucher.

💰 Pas de charge PCI supplémentaire : Évitez la vérification complexe du domaine et la conformité de sécurité, car toutes les transactions de portefeuille s'effectuent en toute sécurité via le paiement hébergé de Mollie.

🛠️ Routage personnalisé de l'annulation : Gardez l'expérience prévisible en renvoyant automatiquement les donateurs qui se retirent vers votre page d'annulation, ou utilisez des filtres de développeur pour les rediriger vers une page personnalisée.

Visitez cette page pour en savoir plus.

ambassadeurs amélioré Nouveau

Écrans de modération et d'annuaire dans Ambassadors 3.0

Ambassadors 3.0 propose de nouvelles fonctionnalités : écrans de modération et d'annuaire... voyez facilement ceux qui gagnent des dons sur votre réseau pair-à-pair, y compris les créateurs de campagnes qui pourraient avoir besoin d'être vérifiés, le tout en un seul endroit. Générez des rapports, envoyez des e-mails directement aux ambassadeurs et aux créateurs de campagnes, et plus encore.

🚀 Voyez quand les créateurs de campagnes et les ambassadeurs ont mis à jour leurs campagnes, ce que les donateurs/dons qu'ils ont apportés et plus encore.

🎉 Ajoutez manuellement des ambassadeurs et des créateurs de campagnes, et approuvez-les en un clic !

Visitez cette page pour en savoir plus.