Online Giving Webhooks

June 30th 2016 Online Giving

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:

  1. Sign to your Online Giving control panel
  2. Click on "Giving Settings" from left navigation
  3. Click on Edit icon next to Webhook URL section.
  4. Enter your Webhook URL
  5. 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 ID
  • f1_txn_id - External Fellowship One Contribution ID
  • f1_status - Fellowship One Contribution Status
  • mp_id - External Ministry Platform User ID
  • mp_txn_id - External Ministry Platform Donation ID
  • mp_status - Ministry Platform Donation Status
  • rockrms_id - External RockRMS User ID
  • rockrms_txn_id - External RockRMS Donation ID
  • rockrms_status - RockRMS Donation Status
  • breeze_id - External Breeze Donor ID
  • breeze_txn_id - External Breeze Donation ID
  • breeze_status - Breeze Donation Status
  • ccb_id - External CCB Donor ID
  • ccb_txn_id - External CCB Donation ID
  • ccb_status - CCH Donation Status
  • acs_env_id - External Envelope ID
  • first_name - Donor First Name
  • last_name - Donor Last Name
  • email - Donor Email
  • amount - Gift Amount
  • payment_date - Gift Unix Timestamp
  • gift_fund - Gift Gift Fund Description
  • gift_fund_id - Gift Gift Fund ID
  • gift_sub_fund - Gift Gift Sub Fund Description
  • gift_sub_fund_id - Gift Gift Sub Fund ID
  • f1_fund_id - External Fellowship One Fund ID
  • f1_sub_fund_id - External Fellowship One Sub Fund ID
  • acs_fund_id - External One Fund ID
  • acs_sub_fund_id - External One Sub Fund ID
  • fund_opt_1 - Fund Option 1
  • sub_fund_opt_1 - Sub Fund Option 1
  • gift_type - Gift Type
  • gift_description - Gift Description
  • payment_type - Gift Payment Type
  • gateway - Gateway Name
  • gateway_txn_id - Gateway Transaction ID
  • gateway_response_msg - Gateway Response Message
  • charge_status - Gift Charge Status
  • notify_status - Gift Email Notify Status
  • sms_id - External SMS ID
  • sms_id - External SMS Message
  • gift_source - Gift Source
  • gift_referral - Gift Referral

Payment Method


  • paymentMethod.name - Gift Payment Name
  • paymentMethod.payment_type - Gift Payment Type
  • paymentMethod.gateway - Gift Payment Gateway
  • paymentMethod.last_4 - Gift Payment Last 4

Donor


  • user.first_name - Donor First Name
  • user.last_name - Donor Last Name
  • user.address - Donor Address
  • user.administrative_area_level_2 - Donor City
  • user.administrative_area_level_1 - Donor State
  • user.postal_code - Donor Postal Code
  • user.country - Donor Country
  • user.opt_out_email - Donor Opt Out Email
  • user.email - Donor Email
  • user.last_login - Donor Last Login Unix Timestamp
  • user.f1_id - Donor External Fellowship One ID
  • user.mp_id - Donor External Ministry Platform ID
  • user.rockrms_id - Donor External RockRMS ID
  • user.ccb_id - Donor External CCB ID
  • user.breeze_id - Donor External Breeze ID
  • user.acs_env_id - Donor External Envelope ID
  • user.google_id - Donor External Google ID
  • user.facebook_id - Donor External Facebook ID

Webhook Transaction Sample Payload: