Learn about our newest features and enhancements!
WebFormContext API

Below is the data available in the WebFormContext JSON Object.  This object is available in all forms created with CharityEngine and contains data like the form ID, StepName, and StepNumber as well as data for each individual field on the form.  

**Please note that AmountSectionMetaData and PaymentSectionMetaData will return null if the CharityEngine system blocks are not used for those corresponding sections.  To learn more about system blocks, click here for the Amount Block.


The data below is present when the donor initially lands on the form:

{

   "AmountSectionMetaData":{

      "FrequencyField_Id":424615,

      "FrequencyOptions":[

         {

            "IsDefault":true,

            "Label":"One-Time",

            "OptionId":731236,

            "Value":"0"

         },

         {

            "IsDefault":false,

            "Label":"Monthly",

            "OptionId":731237,

            "Value":"4"

         }

      ],

      "MonthlyAmountField_Id":424617,

      "MonthlyAmountOptions":[

         {

            "IsDefault":false,

            "Label":"10",

            "OptionId":731243,

            "Value":"10"

         },

         {

            "IsDefault":true,

            "Label":"25",

            "OptionId":731244,

            "Value":"25"

         },

         {

            "IsDefault":false,

            "Label":"50",

            "OptionId":731245,

            "Value":"50"

         },

         {

            "IsDefault":false,

            "Label":"100",

            "OptionId":731246,

            "Value":"100"

         },

         {

            "IsDefault":false,

            "Label":"None",

            "OptionId":731247,

            "Value":"0"

         }

      ],

      "OneTimeAmountField_Id":424616,

      "OneTimeAmountOptions":[

         {

            "IsDefault":false,

            "Label":"25",

            "OptionId":731238,

            "Value":"25"

         },

         {

            "IsDefault":true,

            "Label":"50",

            "OptionId":731239,

            "Value":"50"

         },

         {

            "IsDefault":false,

            "Label":"100",

            "OptionId":731240,

            "Value":"100"

         },

         {

            "IsDefault":false,

            "Label":"250",

            "OptionId":731241,

            "Value":"250"

         },

         {

            "IsDefault":false,

            "Label":"None",

            "OptionId":731242,

            "Value":"0"

         }

      ]

   },

   "Form":{

      "AmexFeePercent":0,

      "EnableDonorPayProcessingFee":false,

      "Fields":[

         {

            "DataMapping":{

               "IsACHType":false,

               "IsAccountNumber":false,

               "IsAccountType":false,

               "IsCVV":false,

               "IsCardType":false,

               "IsCreditCardNumber":false,

               "IsDonationFrequency":true,

               "IsDonorState":false,

               "IsExpirationMonth":false,

               "IsExpirationYear":false,

               "IsNameOnAccount":false,

               "IsNameOnCard":false,

               "IsPayPal":false,

               "IsRoutingNumber":false,

               "PaymentMethod":false,

               "TransactionAmount":false

            },

            "DomId":"ctl00_dropDownList_424615",

            "Id":424615,

            "Name":"Frequency",

            "Section":{

               "Id":33622,

               "Name":"Gift",

               "SystemSectionType":2

            },

            "Type":{

               "Id":4,

               "Name":"Drop Down"

            },

            "Validation":{

               "Currency":false,

               "Required":true

            }

         }

      ],

      "Id":15992,

      "Name":"JSON Form",

      "PayPalFeePercent":2.5,

      "ProcessingFeeFieldDomId":"ctl00_mainFormContentArea_processingFeeAmount",

      "PromoCodeEntryFieldId":"",

      "RenderedViewName":"Initial View",

      "RenderedViewNumber":1,

      "StepName":"Initial Step",

      "StepNumber":1,

      "Type":{

         "Id":1,

         "Name":"Donation"

      },

      "VisaFeePercent":0

   },

   "PaymentSectionMetaData":{

      "IncludeAcH":true,

      "IncludeCVV":false,

      "IncludeCreditCard":true,

      "IncludeNameOnCard":true,

      "IncludePayPal":false

   },

   "SystemDateTime":"\/Date(1600267113853-0400)\/"

}



As the donor progresses through the donation process, the data will update accordingly.  Below is a snippet of the data available after the donor's credit card has been declined:

...

"RenderedViewName":"Error View",

"RenderedViewNumber":3,

"StepName":"Process Step",

"StepNumber":3,

...

Powered by Powered By CharityEngine