The following document outlines donation webhook setup and JSON body payload. Online Giving's donation webhook notification feature is included free of charge with every account. Using donation webhooks allows your church IT staff to receive a real-time callback (notification) of successful (approved) one-time or recurring donations. Please note this feature is designed for the church IT realm (nerds only please).
How to Enable Donation Webhook Callbacks:
- Sign to your Online Giving control panel
- Click on "Giving Settings" from left navigation
- Click on Edit icon next to Webhook URL section.
- Enter your Webhook URL
- Click Save to Commit Changes
Webhook Transaction Overview:
In the section below you will find an overview of the JSON payload structure and a sample JSON payload object. Each payload includes transaction, payment method and donor information.
Got Questions, Need Help? Contact us today. We are always happy to help.
Transaction Information
f1_id
- External Fellowship One Individual IDf1_txn_id
- External Fellowship One Contribution IDf1_status
- Fellowship One Contribution Statusmp_id
- External Ministry Platform User IDmp_txn_id
- External Ministry Platform Donation IDmp_status
- Ministry Platform Donation Statusrockrms_id
- External RockRMS User IDrockrms_txn_id
- External RockRMS Donation IDrockrms_status
- RockRMS Donation Statusbreeze_id
- External Breeze Donor IDbreeze_txn_id
- External Breeze Donation IDbreeze_status
- Breeze Donation Statusccb_id
- External CCB Donor IDccb_txn_id
- External CCB Donation IDccb_status
- CCH Donation Statusacs_env_id
- External Envelope IDfirst_name
- Donor First Namelast_name
- Donor Last Nameemail
- Donor Emailamount
- Gift Amountpayment_date
- Gift Unix Timestampgift_fund
- Gift Gift Fund Descriptiongift_fund_id
- Gift Gift Fund IDgift_sub_fund
- Gift Gift Sub Fund Descriptiongift_sub_fund_id
- Gift Gift Sub Fund IDf1_fund_id
- External Fellowship One Fund IDf1_sub_fund_id
- External Fellowship One Sub Fund IDacs_fund_id
- External One Fund IDacs_sub_fund_id
- External One Sub Fund IDfund_opt_1
- Fund Option 1sub_fund_opt_1
- Sub Fund Option 1gift_type
- Gift Typegift_description
- Gift Descriptionpayment_type
- Gift Payment Typegateway
- Gateway Namegateway_txn_id
- Gateway Transaction IDgateway_response_msg
- Gateway Response Messagecharge_status
- Gift Charge Statusnotify_status
- Gift Email Notify Statussms_id
- External SMS IDsms_id
- External SMS Messagegift_source
- Gift Sourcegift_referral
- Gift Referral
Payment Method
paymentMethod.name
- Gift Payment NamepaymentMethod.payment_type
- Gift Payment TypepaymentMethod.gateway
- Gift Payment GatewaypaymentMethod.last_4
- Gift Payment Last 4
Donor
user.first_name
- Donor First Nameuser.last_name
- Donor Last Nameuser.address
- Donor Addressuser.administrative_area_level_2
- Donor Cityuser.administrative_area_level_1
- Donor Stateuser.postal_code
- Donor Postal Codeuser.country
- Donor Countryuser.opt_out_email
- Donor Opt Out Emailuser.email
- Donor Emailuser.last_login
- Donor Last Login Unix Timestampuser.f1_id
- Donor External Fellowship One IDuser.mp_id
- Donor External Ministry Platform IDuser.rockrms_id
- Donor External RockRMS IDuser.ccb_id
- Donor External CCB IDuser.breeze_id
- Donor External Breeze IDuser.acs_env_id
- Donor External Envelope IDuser.google_id
- Donor External Google IDuser.facebook_id
- Donor External Facebook ID