Charitable Documentation

Learn how to make the most of Charitable with clear, step-by-step instructions.

Charitable Zapier Field Reference

Want to know exactly what data lands in your Zap when a Charitable trigger fires? Each trigger sends a structured payload of donation, donor, recurring-subscription, or campaign fields, and this reference lists every field by trigger type so you can map them confidently into the next step.

This guide will walk you through the fields available in every Charitable Zapier trigger.

Note: Charitable’s Zapier integration requires Charitable Pro 1.8.14+ and the Automation Connect addon 2.1.0+ (Pro plan or higher).

Before you get started, make sure you’ve already Connected Charitable to Zapier.

Donation Trigger Fields

These fields are sent by New DonationDonation CompletedDonation Refunded, and First-Time Donor. The exact same payload shape is used across all four, so a Zap built for one is easy to adapt to the others.

FieldDescriptionExample
donation_idThe internal WordPress post ID for the donation.123
eventThe trigger event slug.donation_completed
titleDonor’s title prefix, when collected on the form.Ms
first_nameDonor’s first name.Wanda
last_nameDonor’s last name.Maximoff
emailDonor’s email address.[email protected]
addressStreet address line.Unit 2b
cityCity.Novi Grad
stateState or region.Novi Grad State
postcodePostal or ZIP code.12345
countryCountry code or full name, depending on form configuration.Sokovia
phoneDonor’s phone number, when collected.987654321
subtotalThe base donation amount, before fees.25
totalThe final donation amount the donor is charged, including any fee they covered.26.50
dateDonation timestamp in ISO 8601 format.2026-05-08T14:20:27+00:00
statusInternal Charitable status with the charitable-prefix. See the status reference below.charitable-completed
donation_gatewaySlug of the payment gateway used.stripepaypalmanual
gateway_transaction_idThe gateway’s transaction reference, useful for reconciliation.ch_abc123def
test_mode1 if the donation was made in the gateway’s test mode, otherwise 0.0
campaign_idThe campaign the donation was made to. When a donation is split across multiple campaigns, this is a comma-separated list of IDs.8
contact_consent1 if the donor opted into being contacted, otherwise 0.1
cover_fees1 if the donor chose to cover the processing fee.1
fee_amountThe portion of total that covers gateway fees.1.50
consent_to_track1 if the donor opted into tracking pixels and analytics.0
newsletter_opt_in1 if the donor opted into the newsletter.1
giftaid1 if the donor claimed Gift Aid (UK donors).0
anonymous_donation1 if the donor chose to display as anonymous publicly.1
donor_commentFree-text message left by the donor with the donation.In memory of Maria

Donation Status Values

The status field uses Charitable’s internal slugs, all prefixed with charitable-. Filter rules and conditional logic should match against these exact values.

  • charitable-completed – payment received and confirmed by the gateway. Use this when you only want to act on real donations.
  • charitable-pending – donation row created but payment not yet confirmed. Common for offline gateways and bank transfers.
  • charitable-failed – gateway reported a failure. The donor was not charged.
  • charitable-cancelled – donor or admin abandoned the transaction.
  • charitable-refunded – the donation was refunded after being completed.

Recurring Subscription Trigger Fields

These fields are sent by New Recurring SubscriptionRecurring Donation RenewedRecurring Subscription Cancelled, and Recurring Payment Failed. The payload describes the recurring plan itself, not a single charge.

FieldDescriptionExample
recurring_donation_idThe post ID of the recurring plan.122
eventThe trigger event slug.subscription_renewed
first_donation_idThe donation ID of the first charge that started this plan.123
recurring_subtotalThe recurring base amount before fees.50
recurring_totalThe recurring charged amount including fees.53
recurring_periodThe unit of recurrence.dayweekmonthyear
recurring_intervalHow many recurring_period units between charges. 1 = every month, 3 = every three months, etc.1
recurring_lengthTotal number of charges. 0means no fixed end.6
recurring_expiration_dateDate the plan ends, ISO 8601. Empty if open-ended.2026-09-08T00:00:00+00:00
recurring_renewal_dateDate of the next scheduled charge, ISO 8601.2026-06-01T00:00:00+00:00
gateway_subscription_idThe gateway’s subscription reference. Useful when reconciling with Stripe or PayPal directly.sub_xyz987
first_nameDonor’s first name.Wanda
last_nameDonor’s last name.Maximoff
emailDonor’s email address.[email protected]
addressaddress_2citystatepostcodecountryphoneDonor’s address and phone, when collected on the form.
subtotalThe base amount of the most recent individual charge.25
totalThe final amount of the most recent individual charge.26.50
dateWhen the plan was created, ISO 8601.2026-05-08T14:20:27+00:00
statusThe plan’s current status. See below.charitable-active
donation_gatewayGateway slug.stripe
test_mode1 if created in test mode.0
campaign_idThe campaign the plan supports. Comma-separated when split.8
contact_consentcover_feesfee_amountconsent_to_tracknewsletter_opt_ingiftaid_claimedanonymous_donationdonor_commentSame meanings as the donation payload above.
gocardless_customer_idGoCardless customer reference, when applicable.goc123123
gocardless_mandate_idGoCardless mandate reference, when applicable.goc987987

Recurring Subscription Status Values

  • charitable-active – the plan is live and renewing on schedule.
  • charitable-cancelled – the donor or admin cancelled the plan.
  • charitable-expired – the plan reached its end date.
  • charitable-failed – a renewal attempt failed and the plan is suspended.

Campaign Trigger Fields

These fields are sent by Campaign Goal Reached and Campaign Ended. The payload describes the campaign itself.

FieldDescriptionExample
campaign_idThe post ID of the campaign.123
eventThe trigger event slug.campaign_goal_reached
titleCampaign title.Year-End Appeal
descriptionShort description text from the campaign.Help us hit our matching goal
goalFundraising goal in your store’s currency.2000
donated_amountTotal raised at the moment the event fired.2045
donor_countTotal number of unique donors.38
end_dateCampaign end date, ISO 8601. Empty if the campaign has no end date.2026-12-31T23:59:59+00:00
dateWhen the campaign was first published, ISO 8601.2026-05-01T10:00:00+00:00
statusWordPress post status.publish
permalinkPublic URL of the campaign.https://example.org/campaigns/year-end/
campaign_creator_idWordPress user ID of the campaign owner.4
campaign_creator_nameDisplay name of the campaign owner.Bruce Banner
campaign_creator_emailEmail address of the campaign owner.[email protected]
recipientWhere the funds go – typically fundraiser for peer-to-peer or parent for child campaigns.fundraiser
post_parentIf the campaign is a peer-to-peer child, the parent campaign’s ID. 0for standalone campaigns.99
fundraiser_typeFor peer-to-peer campaigns, the fundraiser type.individualteam
team_idteam_nameteam_captain_idTeam metadata for peer-to-peer team fundraisers.

Note: For Campaign Goal Reached, the event includes amount_raisedgoal, and percent_funded as additional fields beyond the standard campaign payload. These are calculated at the moment the goal was crossed and won’t update afterward.

Action and Search Inputs

The two action steps and two search steps each have their own input fields visible in the Zap editor. Because input fields evolve more often than trigger payloads, this section is a quick summary rather than an exhaustive table – open the step in the Zap editor for the current full list with help text.

  • Create Donor – accepts donor profile fields (first name, last name, email, address fields, phone, contact consent, newsletter opt-in). Returns the created or matched donor’s full record.
  • Update Donor – takes a lookup field (email or donor ID) plus any of the same donor profile fields. Only fields you provide are changed.
  • Find Donor by Email – takes one input, the email address. Returns the donor’s full record, or no match.
  • Find Campaign – takes either a campaign slug or campaign ID. Returns the campaign payload described in the Campaign Trigger Fields section above.

That’s it! You now know what every Charitable Zapier trigger sends, which means field mapping in any downstream Zap step should be straightforward. Next, see Filtering Charitable Zaps by Campaign to scope a Zap to specific campaigns or conditions, and Connecting Charitable to Zapier for the main getting-started guide.

FAQ

What’s the difference between subtotal and total?

subtotal is the base donation amount the donor selected. total is what was actually charged, which can be higher if the donor opted to cover the gateway’s processing fee. The difference shows up in the fee_amount field.

Why does status always start with charitable-?

Charitable registers its own WordPress post statuses to keep them separate from built-in WordPress statuses like publish and draft. The charitable- prefix is internal but required when filtering – (Text) Exactly matches rules need the full prefixed value, not just completed or refunded.

Are there any fields not in this list?

Yes. Charitable lets developers add custom donation, donor, and campaign fields, and any field marked show_in_webhook in the Donation Fields API is automatically included in the payload alongside the defaults. Check the trigger sample data in the Zap editor to see custom fields added by your specific install or by other Charitable extensions.

Can I send only a subset of fields to my downstream action?

Yes. The Zap editor’s action step lets you map any subset of the trigger’s fields into the action’s inputs. Fields you don’t map are simply ignored. This is the cleanest way to keep CRM contact records uncluttered.

How do I know which campaign a peer-to-peer fundraiser belongs to?

Look at post_parent on a campaign-trigger payload. For child campaigns, post_parent holds the parent campaign’s ID. For standalone campaigns it’s 0.

Still have questions? We’re here to help!

Last Modified:

What's New In Charitable

View The Latest Updates
🔔 Subscribe to get our latest updates
📧 Subscribe to Emails

Email Subscription

Join our Newsletter

We won’t spam you. We only send an email when we think it will genuinely help you. Unsubscribe at any time!

automation update

⚡ Visual Automation Builder: Drag and Drop With No Code!

Charitable Automation Connect 2.3.0 introduces the Visual Automation Builder, a full-screen canvas that lays each automation out as a flow of connected cards: a trigger, optional conditions, and a list of actions that run in order.

🧩 Many actions, one trigger: Tag a donor, send an email, add a note, and fire a webhook from a single event, dragged into any order.

✉️ Act inside Charitable: New Send Email, Tag Donor, and Add Donor Note actions run with no external service required.

🔤 Merge tags: Personalize emails and notes with live fields like {first_name}, {total}, and {campaign_name}.

🔁 Apply to existing donors: Run Tag Donor and Add Donor Note against the donors you already have.

🖥️ Canvas or Simple: Switch views anytime, and automations built before 2.3.0 keep working unchanged.

Read more here.

Integration updated

📬 Introducing Brevo for Charitable: Turn Donors into Subscribers Automatically

The moment a supporter makes a gift is when they are most engaged. With the new Brevo integration for Charitable, you can automatically turn those one-time donors into long-term subscribers without touching a single spreadsheet.

Simply collect donor consent right on your donation form and start your welcome series immediately.

What’s New:

🔄 Automated Subscriber Sync: New donors who opt in are added straight to your Brevo contact list as soon as their payment clears—no manual exports or CSV imports required.

🎯 Granular Consent & Opt-In Control: Customize your checkbox label, choose whether it defaults to checked or unchecked, or turn on Brevo double opt-in to keep your list clean and compliant.

📋 Per-Campaign List Mapping: Route supporters to your global email list or map specific campaigns to targeted Brevo lists to tailor your follow-up messaging.

⚡ 5-Minute Setup: Connect instantly by pasting your Brevo API key into the Newsletter settings, map your contact fields, and start building your email list on autopilot.

Ready to grow your mailing list? Brevo is available now starting on the Charitable Plus plan—connect your account today!

recurring donations updated

💳 Introducing Card Updates: Fix Expired Cards Without Losing Subscriptions!

newExpired or updated credit cards are one of the biggest silent leaks in recurring fundraising. With Card Updates in the Recurring Donations extension, donors can now refresh their payment details directly—keeping their subscription, schedule, and giving history completely intact.

No canceled plans, no lost history, and zero administrative headache for your team.

What’s New:

⚡ 30-Second Self-Service: Donors get a dedicated “Update Card” button in their dashboard that opens Stripe’s secure, PCI-compliant Customer Portal to update card details instantly.

🔒 Scoped & Safe Access: Scoped exclusively to card updates by default, donors can’t accidentally cancel or alter their plans from inside the portal, keeping your webhooks and data in sync.

🤝 Admin-Assisted Support: Helping a donor on the phone? Open their secure Stripe portal in one click from your admin screen or generate a single-use update link to email them.

📋 Automatic Audit Trail: Every payment method update is recorded automatically with a timestamp in both system-wide logs and the individual donor’s profile.

Ready to protect your recurring revenue? Get the Plus or Pro plan and update Recurring Donations to 2.3.0+ and enable “Update Payment Method” under your Settings today!

Integration page builder

Divi Fans Rejoice! Native Divi 5 Campaign Progress Bar Module!

With our new native Divi 5 module, you can anchor your microsites with real-time fundraising stats directly on the visual canvas. Here’s how it works, and why it’s worth turning on today.

Create campaign updates that are VISUAL AND LIVE. You can also:

📊 Campaign Progress Bar: Drop a live progress bar into any Divi 5 layout and show goal progress in real time.

🎨 Deep styling controls: Easily customize the bar and track color, height, and radius to match your brand perfectly.

👁️ Visual Builder ready: Configure and preview everything directly on the Divi canvas as a first-class module.

🔁 Identical rendering: The same exact engine powers this module, meaning consistent design without legacy shims.

✅ Faster launches: Never leave the Divi 5 interface to configure shortcodes or guess how your goal labels will look.

Learn more here.

Integration page builder

👉🏻 New in Charitable: Native Elementor Widgets for Seamless Campaign Building

With native Elementor widgets, you design donation campaigns right alongside the rest of your page without touching code. Here’s how it works, and why it’s worth turning on today.

Create fundraising pages that are VISUAL, NATIVE, AND SHORTCODE-FREE. You can also:

⚡ Mini Donation: Add a compact, high-converting donation widget with preset amounts and full color control.

⏳ Campaign Countdown: Build urgency for a deadline-driven appeal, complete with optional confetti when the goal is hit.

📣 Donation Feed: Prove momentum by showing visitors the social proof of real people giving right now.

🏆 Donor Leaderboard: Celebrate top supporters with gold, silver, and bronze styling to spark friendly giving.

🖼️ Campaign Showcase: Feature multiple campaigns in a landing page grid or carousel, with search, filters, and badges.

Learn more here.