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 Donation, Donation Completed, Donation 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.stripe, paypal, manual
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 Subscription, Recurring Donation Renewed, Recurring 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.day, week, month, year
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]
address, address_2, city, state, postcode, country, phoneDonor’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_consent, cover_fees, fee_amount, consent_to_track, newsletter_opt_in, giftaid_claimed, anonymous_donation, donor_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.individual, team
team_id, team_name, team_captain_idTeam metadata for peer-to-peer team fundraisers.

Note: For Campaign Goal Reached, the event includes amount_raised, goal, 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!

ambassadors New

🔑 Introducing Passwordless Fundraisers: Sign Up With Just an Email!

Supporters arrive wanting to help, and then the form asks them to invent a password for a website they may only visit twice. A lot of them stop right there. Passwordless Fundraiser Accounts, new in Charitable Ambassadors 3.5.0, let a supporter start a peer to peer fundraiser with nothing but an email address. Why this is important:

  • 🔑 No password step to lose them at: Switch it on in Charitable » Ambassadors » Templates » Submit Form and the create-fundraiser form asks only for a name, an email address and a page title.
  • 👤 Still a real WordPress account: One click in one email confirms the address, signs them in and creates the account, so they can come back later to edit their story, change their photo and see who has donated.
  • 🎚️ Your call on every campaign: Each peer to peer campaign can follow the site default or override it, which matters when a campaign pays fundraisers through Stripe Connect and those people do need a password.
  • 📋 See who has not clicked yet: The Charitable » Ambassadors » Directory » Awaiting Sign-In tab lists everyone still waiting, with the campaign they joined and a Resend button, so a typo or a spam folder is something you can spot and fix.
  • 🛡️ Links a scanner cannot use up: Opening the link only shows a page, and your fundraiser is signed in when they press the button on it, so corporate email scanners never burn the link. Each one works once, expires on its own and is stored only as a hash.

Check out our announcement here.

ambassadors New

🏃 Introducing Activity: Show Progress on More Than Money!

Most peer-to-peer fundraisers are about more than the money. A read-a-thon is about minutes read, a walkathon is about miles walked, and a food drive is about meals packed. Activity for Charitable Ambassadors lets your fundraisers show that effort right beside the dollars they raise. Why this is important:

  • 🎯 Progress on what you actually count: A progress bar shows each thing you count against its own target, sitting right beside the money raised.
  • 🏅 Milestones for the yes or no things: A milestone badge marks the efforts that are simply done or not done, with no number to chase.
  • ✍️ Fundraisers log their own numbers: Your supporters enter their totals from their own pages, so the effort stops living in a spreadsheet, a comment, or nowhere at all.
  • 🤖 Some numbers count themselves: An AUTOMATIC tag appears wherever the site worked the figure out from completed donations, so you can see at a glance what nobody typed in.
  • 🧩 Set it up once, use it anywhere: You decide what gets counted one time, then choose which campaigns count it. Available now in Charitable Ambassadors 3.4.7, with no new plugin and no developer.

Check out our announcement here.

ambassadors New

🖨️ Introducing Fliers and Posters: Raise Money Away From the Screen!

A lot of peer-to-peer fundraising happens away from a screen: at the finish line of a 5K, on a school noticeboard, in an office kitchen. Charitable Ambassadors 3.4.7 adds 2 printables, a fundraiser flier carrying each fundraiser’s own story and QR code, and a recruitment poster that signs new fundraisers up. Both open as a normal web page and print straight from the browser. Why this is important:

  • 🏁 A flier for every fundraiser: Each one carries that fundraiser’s own photo, story and goal, with a QR code that opens their page rather than your main campaign.
  • 📌 A poster that recruits: It shows “Now Recruiting” above your campaign name with a large QR code that opens your sign-up form, so someone can start fundraising without waiting on a link from you.
  • 🪄 No design tool needed: Both printables render as a normal web page and print from the browser, with no PDF plugin and no designer.
  • 📄 2 flier layouts: Hand out carries the full story for giving to friends and family, and Post up carries a short hook with 5 tear-off tabs for a noticeboard.
  • 🛡️ Off until you switch it on: Fliers stay off after the update until you enable them under Charitable » Ambassadors » Other » Fliers, and only the owner or an administrator can open one.

Check out our announcement here.

Improvement Payments

💸 Introducing Tiered Rates for Fee Relief: Match the Ask to the Gift!

Fee Relief asks your donors one short question at checkout: would you like to cover the processing fee on this gift? Until now that question used a single rate for every donation on a gateway, so a $10 gift and a $500 gift were asked for the same percentage. Fee Relief 1.3.0 lets you set as many donation bands as you like, each carrying its own rate. Why this is important:

  • 🪙 Gentler on small gifts: A fixed transaction cost is a far bigger share of a $10 donation than a $500 one, so bands let you ask for less at the bottom.
  • 🎚️ As many bands as you need: Each band carries its own percentage and its own fixed amount, and the top band runs on with no upper limit.
  • 🛑 An optional ceiling: A Maximum fee field stops any donor being asked for more than a number you choose, however large the gift.
  • 🔌 Set per payment gateway: Stripe can run on four bands while Windcave and Payfast stay on a single rate, because bands belong to a gateway and not to your whole site.
  • 🛡️ Nothing changes until you say so: Your current rates stay exactly as they are until you switch Use Tiered Rates on under Charitable » Settings » Advanced » Fee Relief.

Check out our announcement here.

Donations Improvement

📊 Your Pro Dashboard Can Now Compare, Export, and Score!

Most fundraising dashboards only tell you how much you have raised. Charitable Pro 1.8.19 rebuilds the dashboard and the Reports Overview around the harder questions: whether anything is broken, whether this period beat the last one, and which single change would make the most difference today. Why this is important:

  • 📈 Every figure has a trend: Pick a period and the tiles and the chart move together, with each total shown against the previous period.
  • 🗓️ Charts that stay readable: Short ranges group donations day by day, while longer ranges group by week or month, so a full year reads as a curve instead of a flat line.
  • 🔀 Compare any 2 periods: Not just consecutive ones, so you can ask how this December did against last December. That matters because fundraising is seasonal.
  • 📤 Export the whole summary: Send the full overview out as CSV or PDF, ready for a board pack or a funder report.
  • 🎯 Score your setup for free: Have your fundraising setup scored, so the one change worth making next is the one you can see.

Check out our announcement here.