Anedot can post Action Page Submissions, Donations, and Commitment data to other applications in real-time when there's a change in your Anedot fundraising account.
Webhooks allow an application to be notified of changes in Anedot. They are intended to provide an efficient way for integrations that react to creations or state changes in Anedot. Allow your integration to take action only when something is created or changed.
You will need to set up an endpoint URL to accept POST JSON requests.
Signatures are provided for each webhook request to verify the authenticity of the request. Verify the signature by producing a SHA-256 HMAC hexdigest using the webhook's secret token as the private key and the webhook body represented as a JSON string. The hexdigest you calculate should match the value in our "X-Request-Signature" header for that webhook request.
Webhook Objects
Submission - Immutable required container with lead information, and 1 or more donation entries if available.
Donation - Immutable, hosted gift, recurrence of a commitment, or payment.
Product - Immutable product description optional associated with a donation and submission.
Commitment - Mutable optional commitment from donor to be charged on a scheduled interval.
Setup
Quick Tip: Create separate webhooks for submission events and donation events for better processing.
Select which Action Pages you would like to sync with webhooks (default: all Action Pages).
Optionally, you can also add Action Pages you want excluded from webhooks (by ID, multiple values must be comma separated).
Optionally, you can also scope the integration to only send team-specific data through webhooks (if no team is selected it will sync all Action Pages specified in the fields above).
Enter your Webhook name.
Enter your Webhook URL (https format).
Optionally, you can add a template for how you want the payload to look when received.
Enable the integration and select your webhook events.
Once you save the credentials, you are all set!
Note: The Action Pages, Team, credentials, and events can be modified at any time post-setup.
Data Relays
We send relays for financial and non-financial pages (specified by trigger events selected in setup).
Create separate webhooks for submission events and donation events for better processing.
Custom fields are relayed and, if consumable for the customer endpoint, supported.
Push Unsent (failed donations, all donations) + date range for relays works for all Action Pages, regardless of page type.
Field Mapping
Note: Webhook field names are customizable; below are the default field names from our templates.
Anedot Field | Webhook Field | Anedot Event(s) |
account_name | account_name | donation, submission |
account_uid | account_uid | donation, submission |
action_page_id | action_page_id | donation, submission, commitment |
action_page_name | action_page_name | donation, submission, commitment |
address_city | address_city | donation, submission, commitment |
address_country | address_country | donation, submission, commitment |
address_line_1 | address_line_1 | donation, submission, commitment |
address_line_2 | address_line_2 | donation, submission, commitment |
address_postal_code | address_postal_code | donation, submission, commitment |
address_region | address_region | donation, submission, commitment |
amount_in_dollars | amount_in_dollars | donation |
cancellation_reason | cancellation_reason | commitment |
cancelled_on | cancelled_on | commitment |
card_expiration | card_expiration | submission |
card_last_digits | card_last_digits | submission |
card_type | card_type | submission |
changed_attributes [object, includes: paused_on, updated_at, frequency, address_line_1, address_line_2, address_city, address_region, address_postal_code] | changed_attributes [object, multiple values] | commitment (source) |
check_number | check_number | donation |
commitment_recurring_until | commitment_recurring_until | donation |
commitment_uid | commitment_uid | donation |
communications_consent_email | communications_consent_email | donation, submission, commitment |
communications_consent_phone | communications_consent_phone | donation, submission, commitment |
created_at | created_at | donation, submission, commitment |
currently_employed | currently_employed | donation, submission, commitment |
custom_field_responses [object, includes: custom field name, custom field response value] | custom_field_responses [object, multiple values] | donation, submission |
date | date | donation |
donation_amount | donation_amount | submission |
donation | donation [object, multiple values] | donation |
donations | donations [object, multiple values] | submission |
donor_profile_id | donor_profile_id | donation, submission, commitment |
donation, submission, commitment | ||
employer_name | employer_name | donation, submission, commitment |
event__amount | event__amount | donation |
first_name | first_name | donation, submission, commitment |
frequency | frequency | donation, commitment |
fund_allocations [object, includes: id, name, identifier, amount_in_dollars] | fund_allocations [object, multiple values] | commitment |
id | id | submission, commitment |
ip_address | ip_address | donation, submission, commitment |
is_recurring_commitment | is_recurring_commitment | donation |
last_name | last_name | donation, submission, commitment |
middle_name | middle_name | donation, submission, commitment |
name | name | donation |
net_amount | net_amount | donation |
next_capture_on | next_capture_on | commitment |
occupation | occupation | donation, submission, commitment |
Organization/Business Name | organization | donation, submission |
origin | origin | donation |
payment_description | payment_description | donation |
payment_method_id | payment_method_id | donation, commitment |
payment_method_type | payment_method_type | submission |
payment_status_message | payment_status_message | commitment |
phone | phone | donation, submission, commitment |
pledge (no corresponding Anedot submission field) | pledge (boolean - true/false) | submission |
captured_at | pledge_capture_date | submission |
product_code | product_code | submission |
product_id | product_id | submission |
product_name | product_name | submission |
product_value | product_value | submission |
recurring | recurring | donation |
referrer_to_form | referrer_to_form | donation, submission, commitment |
referrer | referrer | donation, submission, commitment |
source_code | source_code | donation, submission |
source | source | donation |
status | status | donation |
submission_id | submission_id | donation, commitment |
suffix | suffix | donation, submission, commitment |
title | title | donation, submission, commitment |
token | token | commitment |
total_amount_in_dollars | total_amount_in_dollars | commitment |
updated_at | updated_at | donation, submission, commitment |
utm_campaign | utm_campaign | donation, submission |
utm_content | utm_content | donation, submission |
utm_medium | utm_medium | donation, submission |
utm_source | utm_source | donation, submission |
utm_term | utm_term | donation, submission |
whodunnit | whodunnit | commitment |
Webhook Events
Subscribing to events for more than one of the above objects on a single webhook will trigger the webhook once for each object (e.g., a submission with a donation would trigger the webhook twice, once with the Submission payload and once with the Donation payload).
Setting Name | event | Description |
Commitment Created | commitment_created | A new recurring commitment was created |
Commitment Failed To Process | commitment_failed_to_process | A recurrence of a commitment failed to charge the donor an automated donation |
Commitment Updated | commitment_updated | Changes were made to commitment, name, address, amount, or schedule frequency, or commitment canceled |
Donation ACH Returned | donation_ach_returned | Check return |
Donation Chargeback | donation_chargeback | Check chargeback |
Donation Chargeback Reversed | donation_chargeback_reversed | Chargeback reversed |
Donation Completed | donation_completed | Successful donation from a submission or commitment |
Donation Partially Refunded | donation_partially_refunded | Refund less than the full donation amount |
Donation Refunded | donation_refunded | Full refund, with or without fees |
Donation Voided | donation_voided | Donation void occurred, no charge was made |
Submission Created | submission_created | A new submission was created |
Donation Settled | settlement_date | Associated settlement was completed |
Note: due to potential confusion from the submission_created webhook getting fired twice (once on create, once on purchase), we added a submission_pledged event to differentiate from submission_created. This allows accounts using submissions without pledges to continue receiving the normal data and accounts desiring future pledge tracking to effectively "opt-in" by adding the new event.
When a future pledge is submitted, only a
submission_pledgedevent is sent (if set up to relay).When future pledges are charged, both
submission_createdanddonation_completedevents are relayed.
Payload Message Examples:
attribute examples | format | example value |
submission_id | uuid | f42e7e4f-c93d-4956-a5a2-efab4eef4558 |
event_date | ISO UTC date | 2020-12-11 22:06:26 UTC |
net_amount | decimal money as string | 23.70 |
Donation Created via Donation Page:
amount_in_dollars | full amount of donation or payment |
net_amount | payment minus fees |
commitment_uid | if present associated commitment |
origin | hosted if via form, recurring if via commitment schedule |
custom_field_responses | example radio custom field |
products > internal_identifier | Product id or SKU created via Action Pages > Products |
created_at | Original submission date (UTC) |
updated_at | Any subsequent changes to a message payload (UTC) |
Other Commitment Attributes of Interest:
attribute | value | explanation |
cancellation_reason | failure | When a commitment is canceled because of multiple declines |
account_cancellation | Indicates that an account admin canceled a commitment |
|
schedule | Indicates that the commitment had a set expiration date that passed |
|
nil | Indicates that an Anedot staff member canceled a commitment at a donor's request |
|
donor | Indicates that the donor canceled their commitment. |
|
whodunnit | email of user | Indicates the user that made a change to the commitment. Nil if changed internally by Anedot. |
payment_status_message | varies | Relays a value from the payment provider first-time payment is declined on a recurring. |
Action Page Webhook Templates
While the Submissions, Donations, and Commitments templates share several common properties, they are not identical.
For that reason, it is not recommended to subscribe to different template types on the same webhook.
Create a new webhook for each template type (use one webhook for Submissions, one for Donations, etc).
Submission Template
{
"account_name": "{{account_name}}",
"account_uid": "{{account_uid}}",
"action_page_id": "{{action_page_id}}",
"action_page_name": "{{action_page_name}}",
"address_line_1": "{{address_line_1}}",
"address_line_2": "{{address_line_2}}",
"address_city": "{{address_city}}",
"address_region": "{{address_region}}",
"address_postal_code": "{{address_postal_code}}",
"address_country": "{{address_country}}",
"card_type": "{{card_type}}",
"card_last_digits": "{{card_last_digits}}",
"card_expiration": "{{card_expiration}}",
"communications_consent_email": "{{communications_consent_email}}",
"communications_consent_phone": "{{communications_consent_phone}}",
"created_at": "{{created_at}}",
"currently_employed": "{{currently_employed}}",
"custom_field_responses": "<<custom_field_responses>>",
"donation_amount": "{{donation_amount}}",
"donations": "<<donations>>",
"donor_profile_id": "{{donor_profile_id}}",
"email": "{{email}}",
"employer_name": "{{employer_name}}",
"first_name": "{{first_name}}",
"id": "{{id}}",
"ip_address": "{{ip_address}}",
"last_name": "{{last_name}}",
"middle_name": "{{middle_name}}",
"occupation": "{{occupation}}",
"payment_method_type": "{{payment_method_type}}",
"phone": "{{phone}}",
"product_code": "{{product_code}}",
"product_id": "{{product_id}}",
"product_name": "{{product_name}}",
"product_value": "{{product_value}}",
"referrer": "{{referrer}}",
"referrer_to_form": "{{referrer_to_form}}",
"source_code": "{{source_code}}",
"suffix": "{{suffix}}",
"title": "{{title}}",
"updated_at": "{{updated_at}}",
"utm_campaign": "{{utm_campaign}}",
"utm_content": "{{utm_content}}",
"utm_medium": "{{utm_medium}}",
"utm_source": "{{utm_source}}",
"utm_term": "{{utm_term}}"
}
Donation Template
{
"account_name": "{{account_name}}",
"account_uid": "{{account_uid}}",
"action_page_id": "{{action_page_id}}",
"action_page_name": "{{action_page_name}}",
"address_city": "{{address_city}}",
"address_country": "{{address_country}}",
"address_line_1": "{{address_line_1}}",
"address_line_2": "{{address_line_2}}",
"address_region": "{{address_region}}",
"address_postal_code": "{{address_postal_code}}",
"amount_in_dollars": "{{amount_in_dollars}}",
"check_number": "{{check_number}}",
"commitment_recurring_until": "{{commitment_recurring_until}}",
"commitment_uid": "{{commitment_uid}}",
"custom_field_responses": "<<custom_field_responses>>",
"date": "{{date}}",
"date_iso8601": "{{date_iso8601}}",
"donation": "<<donation>>",
"email": "{{email}}",
"employer_name": "{{employer_name}}",
"event_amount": "{{event_amount}}",
"first_name": "{{first_name}}",
"frequency": "{{frequency}}",
"last_name": "{{last_name}}",
"middle_name": "{{middle_name}}",
"name": "{{name}}",
"net_amount": "{{net_amount}}",
"occupation": "{{occupation}}",
"organization": "{{organization}}",
"origin": "{{origin}}",
"payment": "{{source}}",
"payment_description": "{{payment_description}}",
"phone": "{{phone}}",
"prefix": "{{title}}",
"processed_date": "{{created_at}}",
"recurring": "{{recurring}}",
"referrer": "{{referrer}}",
"referrer_to_form": "{{referrer_to_form}}",
"source_code": "{{source_code}}",
"status": "{{status}}",
"suffix": "{{suffix}}",
"updated_at": "{{updated_at}}",
"utm_campaign": "{{utm_campaign}}",
"utm_content": "{{utm_content}}",
"utm_medium": "{{utm_medium}}",
"utm_source": "{{utm_source}}",
"utm_term": "{{utm_term}}"
}
Commitment Template
{
"id": "{{id}}",
"total_amount_in_dollars": "{{total_amount_in_dollars}}",
"fund_allocations": "<<fund_allocations>>",
"next_capture_on": "{{next_capture_on}}",
"cancelled_on": "{{cancelled_on}}",
"token": "{{token}}",
"frequency": "{{frequency}}",
"action_page_id": "{{action_page_id}}",
"action_page_name": "{{action_page_name}}",
"donor_profile_id": "{{donor_profile_id}}",
"payment_method_id": "{{payment_method_id}}",
"submission_id": "{{submission_id}}",
"created_at": "{{created_at}}",
"updated_at": "{{updated_at}}",
"address_line_1": "{{address_line_1}}",
"address_line_2": "{{address_line_2}}",
"address_city": "{{address_city}}",
"address_region": "{{address_region}}",
"address_postal_code": "{{address_postal_code}}",
"address_country": "{{address_country}}",
"email": "{{email}}",
"phone": "{{phone}}",
"first_name": "{{first_name}}",
"last_name": "{{last_name}}",
"middle_name": "{{middle_name}}",
"occupation": "{{occupation}}",
"employer_name": "{{employer_name}}",
"title": "{{title}}",
"suffix": "{{suffix}}",
"ip_address": "{{ip_address}}",
"referrer": "{{referrer}}",
"referrer_to_form": "{{referrer_to_form}}",
"communications_consent_email": "{{communications_consent_email}}",
"communications_consent_phone": "{{communications_consent_phone}}",
"currently_employed": "{{currently_employed}}",
"payment_status_message": "{{payment_status_message}}",
"changed_attributes": "<<changed_attributes>>",
"cancellation_reason": "{{cancellation_reason}}",
"whodunnit": "{{whodunnit}}",
"status": "{{status}}"
}
Payload Data
Request Headers
{
"User-Agent": "Anedot-Hookshot/58c89d9",
"X-Request-Id": "a338c125-dc08-49ca-b554-d810b11d241f",
"X-Integration-Id": "253a6c61-e7a3-42f6-b42b-c0c397e37cdd",
"X-Integration-Event": "{{event name}}",
"X-Request-Signature": "cd5a0f7c316888b284b6212bccb92fb12eb34aab766d58d040b3b45a39fb2128"
}
Submission Created
{
"event": "submission_created",
"payload": {
"id": "fb0e86ac-1655-4e40-bda1-a988c3557559",
"email": "[email protected]",
"phone": "12252501301",
"title": "",
"suffix": "",
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/ba6f2fce-e953-400c-8052-0fb86952b44e",
"utm_term": "",
"card_type": "",
"donations": [],
"last_name": "Dot",
"created_at": "2023-05-19 20:58:56 UTC",
"first_name": "Annie",
"ip_address": "64.152.236.103",
"occupation": "retired",
"product_id": "",
"updated_at": "2023-05-19 20:58:56 UTC",
"utm_medium": "",
"utm_source": "",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "",
"utm_content": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"product_code": "",
"product_name": "",
"utm_campaign": "",
"employer_name": "retired",
"product_value": "",
"action_page_id": "ba6f2fce-e953-400c-8052-0fb86952b44e",
"address_line_1": "1340 Poydras St",
"address_line_2": "",
"address_region": "LA",
"address_country": "US",
"card_expiration": "",
"donation_amount": "$0.00",
"action_page_name": "Giving Day 2023",
"card_last_digits": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "https://anedot-sandbox.com/",
"created_at_iso8601": "2023-05-19T20:58:56Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-05-19T20:58:56Z",
"address_postal_code": "12345",
"payment_method_type": "",
"custom_field_responses": {
"event": null,
"appeal_id": "W2207A1A",
"t-shirt_size": "S",
"volunteering_timeslots": [],
"t-shirt_color_-_first_preference": "Green",
"t-shirt_color_-_second_preference": "Blue"
},
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Submission Pledged
{
"event": "submission_pledged",
"payload": {
"id": "9f4b6cd1-08ba-4938-bce8-3f470ee9204f",
"email": "[email protected]",
"phone": "12252501301",
"title": "",
"pledge": "true",
"suffix": "",
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/ba6f2fce-e953-400c-8052-0fb86952b44e",
"utm_term": "",
"card_type": "master",
"donations": [],
"last_name": "Dot",
"created_at": "2023-11-02 15:03:16 UTC",
"first_name": "Annie",
"ip_address": "2600:1700:8300:21c0:9167:1676:4953:cd1b",
"occupation": "Support Specialist",
"product_id": "",
"updated_at": "2023-11-02 15:03:16 UTC",
"utm_medium": "",
"utm_source": "",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "",
"source_code": "",
"utm_content": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"organization": "",
"product_code": "",
"product_name": "",
"utm_campaign": "",
"employer_name": "Anedot",
"product_value": "",
"action_page_id": "b290b1af-f94c-4b07-917f-82638436a36b",
"address_line_1": "1340 Poydras St",
"address_line_2": "",
"address_region": "LA",
"address_country": "US",
"card_expiration": "12/2031",
"donation_amount": "$25.00",
"action_page_name": "Giving Day 2023",
"card_last_digits": "8888",
"donor_profile_id": "",
"referrer_to_form": "",
"created_at_iso8601": "2023-11-02T15:03:16Z",
"currently_employed": "true",
"updated_at_iso8601": "2023-11-02T15:03:16Z",
"address_postal_code": "70816",
"payment_method_type": "credit_card",
"pledge_capture_date": "2023-11-03 00:00:00 -0500",
"custom_field_responses": {
"date": null,
"birthday": null,
"checkbox": [],
"radio_test": null,
"requirement": true,
},
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Commitment Created
{
"event": "commitment_created",
"payload": {
"id": "84929e34-2d2b-4480-8229-b06c61983c32",
"total_amount_in_dollars": "25.0",
"next_capture_on": "2024-04-22 17:36:09 UTC",
"cancelled_on": "",
"cancelled_on_iso8601": "",
"token": "Lu4jYGa4MGgx1MfCcTxfx2HG",
"frequency": "monthly",
"action_page_id": "ba2cf006-3342-432c-a32e-2decba5b0964",
"action_page_name": "Donation Page",
"donor_profile_id": "90f5a9bf-6c36-4326-9c5f-bdfda5e14f36",
"payment_method_id": "bb66e990-bb0b-4965-b1eb-7b5c932d4763",
"submission_id": "f6e4bc33-f349-49d2-bf2d-aa80bda65e38",
"created_at": "2024-03-22 17:36:09 UTC",
"created_at_iso8601": "2024-03-22T17:36:09Z",
"updated_at": "2024-03-22 17:36:09 UTC",
"updated_at_iso8601": "2024-03-22T17:36:09Z",
"address_line_1": "1340 Poydras St",
"address_line_2": "",
"address_city": "New Orleans",
"address_region": "LA",
"address_postal_code": "70113",
"address_country": "US",
"email": "[email protected]",
"phone": "12015550123",
"first_name": "Annie",
"last_name": "Dot",
"middle_name": "",
"occupation": "",
"employer_name": "",
"title": "",
"suffix": "",
"ip_address": "149.34.250.35",
"referrer": "https://secure.anedot-sandbox.com/helpallcauses/1607c80e-8f93-45f4-bc24-88ef95f740e9",
"referrer_to_form": "https://anedot-sandbox.com/",
"communications_consent_email": "false",
"communications_consent_phone": "false",
"currently_employed": "",
"payment_status_message": "",
"cancellation_reason": "",
"whodunnit": "",
"status": "active",
"fund_allocations": [
{
"amount_in_dollars": "25.0",
"fund": {
"id": "97059101-e62e-46e9-9038-909c337b9b4c",
"identifier": "1001",
"name": "General Fund"
}
}
],
"changed_attributes": {}
}
}
Commitment Failed
{
"event": "commitment_failed_to_process",
"payload": {
"id": "c89cc126-853d-42ec-85dd-d56834722413",
"total_amount_in_dollars": "10.3",
"fund_allocations": [
{
"amount_in_dollars": "10.3",
"fund": {
"id": "3bfe8049-aa5a-4db1-840c-c1ede521dd5c",
"identifier": "95263a32-4dc8-4e41-8ea1-174d527472f9",
"name": "General Fund"
}
}
],
"next_capture_on": "2021-04-03 12:55:10 UTC",
"cancelled_on": "",
"expired_on": "",
"failed_on": "",
"paused_on": "",
"token": "1500139abd7729e85079362ae4a8c768cd5d0b70",
"frequency": "monthly",
"action_page_id": "b9cb82d0-2e19-4ff1-9cf1-3a8a4b8f02ce",
"action_page_name": "Commitment Page",
"donor_profile_id": "",
"payment_method_id": "952219f9-b345-46c2-9e88-c362e4ba626f",
"submission_id": "3af17864-9db0-4083-b18b-d88d043266dc",
"created_at": "2021-01-03 12:55:10 UTC",
"updated_at": "2021-03-17 16:44:50 UTC",
"address_line_1": "123 Pelinor Way",
"address_line_2": "",
"address_city": "Pelinor",
"address_region": "TX",
"address_postal_code": "76545",
"address_country": "US",
"email": "[email protected]",
"phone": "8765456789",
"first_name": "Gandalf",
"last_name": "Thegrey",
"middle_name": "",
"occupation": "retired",
"employer_name": "",
"title": "",
"suffix": "",
"ip_address": "127.0.0.1",
"referrer": "http://secure.anedot.me:3000/washington/b9cb82d0-2e19-4ff1-9cf1-3a8a4b8f02ce",
"referrer_to_form": "",
"communications_consent_email": "",
"communications_consent_phone": "",
"currently_employed": "false",
"payment_status_message": "Declined"
"changed_attributes": {},
"cancellation_reason": "",
"whodunnit": "",
"status": "active",
}
}
Commitment Updated with Cancellation Reason
{
"event": "commitment_updated",
"payload": {
"id": "c89cc126-853d-42ec-85dd-d56834722413",
"total_amount_in_dollars": "10.3",
"fund_allocations": [
{
"amount_in_dollars": "10.3",
"fund": {
"id": "3bfe8049-aa5a-4db1-840c-c1ede521dd5c",
"identifier": "95263a32-4dc8-4e41-8ea1-174d527472f9",
"name": "General Fund"
}
}
],
"next_capture_on": "2021-04-03 12:55:10 UTC",
"cancelled_on": "2021-03-17 00:00:00 UTC",
"expired_on": "",
"failed_on": "",
"paused_on": "",
"token": "1500139abd7729e85079362ae4a8c768cd5d0b70",
"frequency": "monthly",
"action_page_id": "b9cb82d0-2e19-4ff1-9cf1-3a8a4b8f02ce",
"action_page_name": "Commitment Page",
"donor_profile_id": "",
"payment_method_id": "952219f9-b345-46c2-9e88-c362e4ba626f",
"submission_id": "3af17864-9db0-4083-b18b-d88d043266dc",
"created_at": "2021-01-03 12:55:10 UTC",
"updated_at": "2021-03-17 16:52:48 UTC",
"address_line_1": "123 Pelinor Way",
"address_line_2": "",
"address_city": "Pelinor",
"address_region": "TX",
"address_postal_code": "76545",
"address_country": "US",
"email": "[email protected]",
"phone": "8765456789",
"first_name": "Gandalf",
"last_name": "Thegrey",
"middle_name": "",
"occupation": "retired",
"employer_name": "",
"title": "",
"suffix": "",
"ip_address": "127.0.0.1",
"referrer": "http://secure.anedot.me:3000/washington/b9cb82d0-2e19-4ff1-9cf1-3a8a4b8f02ce",
"referrer_to_form": "",
"communications_consent_email": "",
"communications_consent_phone": "",
"currently_employed": "false",
"payment_status_message": "",
"changed_attributes": {
"cancelled_on": [
null,
"2021-03-17 00:00:00 UTC"
],
"updated_at": [
"2021-03-17 16:44:50 UTC",
"2021-03-17 16:52:48 UTC"
]
},
"cancellation_reason": "failure"
"whodunnit": "",
"status": "active"
}
}
Donation Completed
{
"event": "donation_completed",
"payload": {
"date": "2023-05-19 21:16:55 UTC",
"name": "Annie Dot",
"email": "[email protected]",
"phone": "12252501301",
"title": "",
"origin": "hosted",
"source": "credit_card",
"status": "completed",
"suffix": "",
"donation": {
"id": "d6b2fcd4406f382b4c23a",
"fees": {
"anedot_fees": {
"amount": "4.30"
},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "05/2023"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/e36d4264-b96b-4b77-9e01-3dac28e9914a",
"utm_term": "",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-19 21:16:54 UTC",
"first_name": "Annie",
"ip_address": "64.152.236.103",
"net_amount": "95.70",
"occupation": "",
"updated_at": "2023-05-19 21:16:55 UTC",
"utm_medium": "",
"utm_source": "",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "",
"source_code": "",
"utm_content": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-19T21:16:55Z",
"event_amount": "100.00",
"organization": "",
"utm_campaign": "",
"employer_name": "",
"submission_id": "86e93be1-3b10-43d5-bf25-cc177377ff6a",
"action_page_id": "00c7b970-c269-4062-979e-b7aa939995fe",
"address_line_1": "1340 Poydras Street",
"address_line_2": "",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "Feed the Children - March Gala",
"commitment_index": "",
"donor_profile_id": "",
"referrer_to_form": "",
"amount_in_dollars": "100.0",
"payment_method_id": "298c1950-5873-4387-ba56-ba6be525b1ad",
"created_at_iso8601": "2023-05-19T21:16:54Z",
"currently_employed": "true",
"updated_at_iso8601": "2023-05-19T21:16:55Z",
"address_postal_code": "70113",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {
"number_of_tickets": null
},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation ACH Returned
{
"event": "donation_ach_returned",
"payload": {
"date": "2023-05-18 15:34:28 UTC",
"name": "Annie Dot",
"email": "[email protected]",
"phone": "18001231234",
"title": "",
"origin": "hosted",
"source": "bank_account",
"status": "ach_returned",
"suffix": "",
"donation": {
"id": "d8689d5b809263e659388",
"fees": {
"anedot_fees": {},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": null,
"card_last_digits": null,
"donation_project": "",
"credit_card_expiration": ""
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/e36d4264-b96b-4b77-9e01-3dac28e9914a",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-18 15:34:28 UTC",
"first_name": "Annie",
"ip_address": "64.152.236.103",
"net_amount": "-25.00",
"occupation": "",
"updated_at": "2023-06-01 14:39:14 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "",
"source_code": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-18T15:34:28Z",
"event_amount": "-25.00",
"employer_name": "",
"submission_id": "d640d468-c34b-481d-976a-f377d4a83c12",
"action_page_id": "00c7b970-c269-4062-979e-b7aa939995fe",
"address_line_1": "1340 Poydras Street",
"address_line_2": "",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "Feed the Children - March Gala",
"commitment_index": "",
"donor_profile_id": "",
"referrer_to_form": "",
"amount_in_dollars": "25.0",
"payment_method_id": "19198da1-8a08-421d-a9a5-c097f7a32978",
"created_at_iso8601": "2023-05-18T15:34:28Z",
"currently_employed": "true",
"updated_at_iso8601": "2023-06-01T14:39:14Z",
"address_postal_code": "70113",
"payment_description": "Personal Checking •••• 0021",
"custom_field_responses": {
"number_of_tickets": null
},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation Chargeback
{
"event": "donation_chargeback",
"payload": {
"date": "2023-05-31 19:09:03 UTC",
"name": "Dr Annie Q Dot",
"email": "[email protected]",
"phone": "2255011234",
"title": "Dr",
"origin": "hosted",
"source": "credit_card",
"status": "chargeback",
"suffix": "",
"donation": {
"id": "d43872c9a174463dae378",
"fees": {
"anedot_fees": {},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "04/2024"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/4670177d-c207-47a5-bc4c-3a5ea5e6a98a?source_code=EOY22",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-31 19:09:03 UTC",
"first_name": "Annie",
"ip_address": "74.80.57.125",
"net_amount": "-100.00",
"occupation": "student",
"updated_at": "2023-06-01 14:40:55 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "EOY22",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-31T19:09:03Z",
"event_amount": "-100.00",
"employer_name": "student",
"submission_id": "63696077-a3c9-4b2b-800e-79f662c1a28a",
"action_page_id": "4670177d-c207-47a5-bc4c-3a5ea5e6a98a",
"address_line_1": "1239 First St",
"address_line_2": "Unit 2",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "EOY Giving 2022",
"commitment_index": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "",
"amount_in_dollars": "100.0",
"payment_method_id": "0443bd15-c322-4129-9465-9ec08ae5d6d4",
"created_at_iso8601": "2023-05-31T19:09:03Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-06-01T14:40:55Z",
"address_postal_code": "12345",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation Chargeback Reversed
{
"event": "donation_chargeback_reversed",
"payload": {
"date": "2023-05-31 19:14:50 UTC",
"name": "Dr Annie Q Dot",
"email": "[email protected]",
"phone": "2255011234",
"title": "Dr",
"origin": "hosted",
"source": "credit_card",
"status": "chargeback_reversed",
"suffix": "",
"donation": {
"id": "d5309b0fc8fbc55a43935",
"fees": {
"anedot_fees": {},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "04/2024"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/4670177d-c207-47a5-bc4c-3a5ea5e6a98a?amount=500&utm_campaign=200",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-31 19:14:50 UTC",
"first_name": "Annie",
"ip_address": "74.80.57.125",
"net_amount": "500.00",
"occupation": "student",
"updated_at": "2023-06-01 14:42:24 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "EOY22",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-31T19:14:50Z",
"event_amount": "500.00",
"employer_name": "student",
"submission_id": "c2eb2ff0-c63d-4bad-a20f-8e972f7e2262",
"action_page_id": "4670177d-c207-47a5-bc4c-3a5ea5e6a98a",
"address_line_1": "1239 First St",
"address_line_2": "Unit 2",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "EOY Giving 2022",
"commitment_index": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "",
"amount_in_dollars": "500.0",
"payment_method_id": "0443bd15-c322-4129-9465-9ec08ae5d6d4",
"created_at_iso8601": "2023-05-31T19:14:50Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-06-01T14:42:24Z",
"address_postal_code": "12345",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation Partially Refunded
{
"event": "donation_partially_refunded",
"payload": {
"date": "2023-05-30 14:02:51 UTC",
"name": "Dr Annie Q Dot",
"email": "[email protected]",
"phone": "2255011234",
"title": "Dr",
"origin": "hosted",
"source": "credit_card",
"status": "partially_refunded",
"suffix": "",
"donation": {
"id": "daa8d0fea46bbec7ede81",
"fees": {
"anedot_fees": {},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "04/2024"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/e36d4264-b96b-4b77-9e01-3dac28e9914a",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-30 14:02:51 UTC",
"first_name": "Annie",
"ip_address": "74.80.57.125",
"net_amount": "-25.00",
"occupation": "student",
"updated_at": "2023-06-01 14:44:03 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-30T14:02:51Z",
"event_amount": "-25.00",
"employer_name": "student",
"submission_id": "7e8beb66-2d93-4a8e-8dd9-4bbe0e45fbfb",
"action_page_id": "00c7b970-c269-4062-979e-b7aa939995fe",
"address_line_1": "1239 First St",
"address_line_2": "Unit 2",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "Feed the Children - March Gala",
"commitment_index": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "https://anedot-sandbox.com/",
"amount_in_dollars": "50.0",
"payment_method_id": "0443bd15-c322-4129-9465-9ec08ae5d6d4",
"created_at_iso8601": "2023-05-30T14:02:51Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-06-01T14:44:03Z",
"address_postal_code": "12345",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {
"number_of_tickets": null
},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation Refunded
{
"event": "donation_refunded",
"payload": {
"date": "2023-05-23 14:37:27 UTC",
"name": "Dr Annie Q Dot",
"email": "[email protected]",
"phone": "2255011234",
"title": "Dr",
"origin": "hosted",
"source": "credit_card",
"status": "refunded",
"suffix": "",
"donation": {
"id": "d4074e5c015b745adb444",
"fees": {
"anedot_fees": {},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "04/2024"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/cab0834d-ad6d-4177-8125-1da2c194f5ef?source_code=Kindness",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-05-23 14:37:27 UTC",
"first_name": "Annie",
"ip_address": "74.80.57.125",
"net_amount": "-100.00",
"occupation": "retired",
"updated_at": "2023-06-01 14:44:46 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "Kindness",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-05-23T14:37:27Z",
"event_amount": "-100.00",
"employer_name": "retired",
"submission_id": "c4b36935-7f93-42b0-ba4c-0cea79e111a8",
"action_page_id": "cab0834d-ad6d-4177-8125-1da2c194f5ef",
"address_line_1": "1239 First St",
"address_line_2": "Unit 2",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "Start the year with kindness",
"commitment_index": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "",
"amount_in_dollars": "100.0",
"payment_method_id": "0443bd15-c322-4129-9465-9ec08ae5d6d4",
"created_at_iso8601": "2023-05-23T14:37:27Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-06-01T14:44:46Z",
"address_postal_code": "12345",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {
"birthday": null,
"appeal_id": "W2207A1A",
"custom_flag_1": "WVT"
},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Donation Settled
{
"event": "donation_settled",
"payload": {
"donation": {
"id": "db94ffdbebde37c85fb1b",
"settlement_date": "2023-01-19 22:12:11 UTC"
}
}
}
Donation Voided
{
"event": "donation_voided",
"payload": {
"date": "2023-06-01 14:46:11 UTC",
"name": "Dr Annie Q Dot",
"email": "[email protected]",
"phone": "2255011234",
"title": "Dr",
"origin": "hosted",
"source": "credit_card",
"status": "voided",
"suffix": "",
"donation": {
"id": "da3aaf6868558a289b60a",
"fees": {
"anedot_fees": {
"amount": "-1.30"
},
"vendor_fees": []
},
"fund": {
"id": "5181b4d8-6075-4c69-8fe7-64d921a86639",
"name": "General Fund",
"identifier": "1001"
},
"products": [],
"card_type": "master",
"card_last_digits": "5454",
"donation_project": "",
"credit_card_expiration": "04/2024"
},
"referrer": "https://secure.anedot-sandbox.com/09388ffc-9f3f-43ee-855a-1f70c7a9b764/e36d4264-b96b-4b77-9e01-3dac28e9914a",
"frequency": "once",
"last_name": "Dot",
"recurring": "false",
"created_at": "2023-06-01 14:46:11 UTC",
"first_name": "Annie",
"ip_address": "74.80.57.125",
"net_amount": "-23.70",
"occupation": "student",
"updated_at": "2023-06-01 14:46:56 UTC",
"account_uid": "aa3480c1cb0b039147824",
"middle_name": "Q",
"source_code": "",
"account_name": "The Charitable Foundation",
"address_city": "New Orleans",
"check_number": "",
"date_iso8601": "2023-06-01T14:46:11Z",
"event_amount": "-25.00",
"employer_name": "student",
"submission_id": "347d5074-5e58-4b2b-97f0-bb4e232a1940",
"action_page_id": "00c7b970-c269-4062-979e-b7aa939995fe",
"address_line_1": "1239 First St",
"address_line_2": "Unit 2",
"address_region": "LA",
"commitment_uid": "",
"address_country": "US",
"action_page_name": "Feed the Children - March Gala",
"commitment_index": "",
"donor_profile_id": "948d2011-2e82-418c-a6e3-3cf2d571dd97",
"referrer_to_form": "https://anedot-sandbox.com/",
"amount_in_dollars": "25.0",
"payment_method_id": "0443bd15-c322-4129-9465-9ec08ae5d6d4",
"created_at_iso8601": "2023-06-01T14:46:11Z",
"currently_employed": "false",
"updated_at_iso8601": "2023-06-01T14:46:56Z",
"address_postal_code": "12345",
"payment_description": "MasterCard •••• 5454",
"custom_field_responses": {
"number_of_tickets": "4"
},
"is_recurring_commitment": "false",
"commitment_recurring_until": "",
"communications_consent_email": "false",
"communications_consent_phone": "false"
}
}
Response Bodies
Success 1
""
Success 2
{
"id": "0183cd84-fc5f-6f63-012f-a9bd5ef47186",
"request_id": "0183cd84-fc5f-6f63-012f-a9bd5ef47186",
"status": "success"
}
Error
{}
Success
200
Response Status
Error
null