API v1 Reference

Donation Webhooks

Webhooks can be sent when donations are created, edited, or deleted. Below are examples of the following actions:

Create Donation

Sent when a donation is created.

{ 
   "eventTrigger":"createDonation",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "donation":{ 
         "createdDateTime":"2013-02-22T02:52:54.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-02-22T02:52:54.000-06:00",
         "lastModifiedBy":"Administrator ",
         "donationId":41733,
         "accountId":123958,
         "amount":300,
         "purpose":{ 
            "id":12,
            "name":"Research"
         },
         "campaign":{ 
            "id":249,
            "name":"$5 Support a Kid"
         },
         "fund":{ 
            "id":11,
            "name":"Benefit Concert"
         },
         "status":"Pending",
         "donorName":"Jason10 Weng",
         "date":"2013-02-20-06:00",
         "acknowledgee":{ 
            "name":"Andrew Jones"
         },
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":603,
               "fieldOptionId":2295
            }
         },
         "solicitation":{ 
            "id":6,
            "name":"Proposal"
         },
         "transaction":{ 
            "transactionId":72223,
            "transactionStatus":"SUCCEED",
            "payments":{ 
               "payment":[ 
                  { 
                     "paymentId":56415,
                     "amount":50,
                     "paymentStatus":"SUCCEED",
                     "tenderType":{ 
                        "id":"4",
                        "name":"Credit Card (Online)"
                     },
                     "creditCardOnlinePayment":{ 
                        "cardNumber":"***********1111",
                        "expirationMonth":1,
                        "expirationYear":20,
                        "cardType":{ 
                           "code":"v",
                           "name":""
                        },
                        "cardHolder":"Example Person"
                     }
                  }
               ]
            }
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Edit Donation

Sent when a donation is updated.

{ 
   "eventTrigger":"editDonation",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "donation":{ 
         "createdDateTime":"2013-02-22T02:52:54.000-06:00",
         "createdBy":"Administrator ",
         "lastModifiedDateTime":"2013-02-22T02:52:54.000-06:00",
         "lastModifiedBy":"Administrator ",
         "donationId":41733,
         "accountId":123958,
         "amount":300,
         "purpose":{ 
            "id":12,
            "name":"Research"
         },
         "campaign":{ 
            "id":249,
            "name":"$5 Support a Kid"
         },
         "fund":{ 
            "id":11,
            "name":"Benefit Concert"
         },
         "status":"Pending",
         "donorName":"Jason10 Weng",
         "date":"2013-02-20-06:00",
         "acknowledgee":{ 
            "name":"Andrew Jones"
         },
         "customFieldDataList":{ 
            "customFieldData":{ 
               "fieldId":603,
               "fieldOptionId":2295
            }
         },
         "solicitation":{ 
            "id":6,
            "name":"Proposal"
         },
         "transaction":{ 
            "transactionId":72223,
            "transactionStatus":"SUCCEED",
            "payments":{ 
               "payment":[ 
                  { 
                     "paymentId":56415,
                     "amount":50,
                     "paymentStatus":"SUCCEED",
                     "tenderType":{ 
                        "id":"4",
                        "name":"Credit Card (Online)"
                     },
                     "creditCardOnlinePayment":{ 
                        "cardNumber":"***********1111",
                        "expirationMonth":1,
                        "expirationYear":20,
                        "cardType":{ 
                           "code":"v",
                           "name":""
                        },
                        "cardHolder":"Example Person"
                     }
                  }
               ]
            }
         }
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}

Delete Donation

Sent when a donation is deleted.

{ 
   "eventTrigger":"deleteDonation",
   "eventTimestamp":"2017-05-04T03:42:59.000-06:00",
   "organizationId":"test",
   "data":{ 
      "donation":{ 
         "donationId":3542,
         "deletedDateTime":"2013-01-24T03:42:59.000-06:00",
         "deletedBy":"Administrator "
      }
   },
   "customParameters":{ 
      "customParameterA":"value",
      "customParameterB":"other value"
   }
}