> For the complete documentation index, see [llms.txt](https://docs.anedot.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.anedot.com/integrations/integration-automation-tools/webhooks.md). # Webhooks (API) Send real-time Anedot webhook events for submissions, donations, and commitments to your endpoint, including objects, payloads, signatures, and field mapping. > For the complete documentation index, see [llms.txt](https://anedot.gitbook.io/anedot-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://anedot.gitbook.io/anedot-docs/integrations/integration-automation-tools/webhooks.md). ## Webhooks (API) Anedot’s Webhooks feature allows you to send real-time updates from Action Page Submissions, Donations, and Commitments to other applications whenever data changes in your Anedot fundraising account. ### Why Use Webhooks? Webhooks are designed to notify external systems of updates in Anedot, enabling your application to react immediately to new submissions or state changes *(e.g., donations, commitments)*. This supports real-time automation such as syncing data or triggering workflows. You will need to provide an endpoint URL where Anedot can send POST JSON requests. These requests are signed for security. > ***Signature Verification*** *Each webhook request includes a SHA-256 HMAC hexdigest signature using the webhook’s secret token and request body. This value is included in the `X-Request-Signature` header and can be used to verify the authenticity of the request.* ### Webhook Objects ![Webhooks — Submission, Donation, Commitment, and Product object relationships](https://1576281756-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FQuNikYKWprVDzRjF4GER%2Fuploads%2FpHvadRtcnFb7ihuDd6Tm%2Fwebhooks-objects.png?alt=media) Anedot sends structured webhook objects representing your fundraising activity: * **Submission** – Contains lead information and one or more linked donation entries. * **Donation** – Details of a gift, recurring payment, or hosted donation. * **Commitment** – A scheduled or future commitment from a donor. * **Product** – Describes an optional product associated with the donation or submission. ### Setup Instructions Follow these steps to configure webhooks in Anedot: 1. Select the **Action Pages** you want to include *(default includes all)*. 2. *(Optional)* Add Action Pages to **exclude** using comma-separated IDs. 3. *(Optional)* Limit by **Team** to only sync data related to a specific team. 4. Enter a **Webhook Name** for internal reference. 5. Input your **Webhook URL** *(must be HTTPS)*. 6. *(Optional)* Add a custom **template** for payload structure. 7. Enable the integration and select webhook events. 8. Save your settings — you're all set! > ***Tip:*** *We recommend setting up separate webhooks for submission and donation events for improved performance and clarity.* ### Data Relays * Webhooks support both **financial and non-financial Action Pages**. * We recommend using separate relays for **Submission** and **Donation Events**. * **Custom fields** are included in payloads when submission data is available. * **Failed Relays**: The webhook will automatically stop sending requests after 1000 failed attempts or errors. * **Push Unsent**: Allows you to resend unsent or failed donation events within a specified date range across all Action Pages.Data can only be resent for events from the past year. ### Field Mapping Webhook field names can be customized. Below are the default mappings from Anedot 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 label, custom field response value] | custom\_field\_responses \[object, multiple values] | donation, submission | | date | date | donation | | donation\_amount | donation\_amount | submission | | donation \[object, includes: id, fees (anedot, vendor), fund (id, name, identifier), product (name, internal identifier), card (type, last digits), donation\_project, credit\_card\_expiration] | donation \[object, multiple values] | donation | | donations \[object, includes: id, fees (anedot, vendor), fund (id, name, identifier), product (id, code, name, value), net amount, gross amount, fees\_paid\_by\_donor] | donations \[object, multiple values] | submission | | donor\_profile\_id | donor\_profile\_id | donation, submission, commitment | | email | email | donation, submission, commitment | | employer\_name | employer\_name | donation, submission, commitment | | eventamount | eventamount | 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 When you subscribe to multiple object types on a single webhook, Anedot will trigger the webhook separately for each object. For example, if a submission includes a donation, the webhook will fire 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 | #### 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 Although the Submissions, Donations, and Commitments templates share some common fields, each has a unique structure. To avoid processing issues, we recommend **not subscribing to multiple template types on a single webhook**. Instead, create a **separate webhook for each template type**—one for Submissions, one for Donations, one for Commitments, and so on. #### Submission Template ```json {"account_name":"","account_uid":"","action_page_id":"","action_page_name":"","address_line_1":"","address_line_2":"","address_city":"","address_region":"","address_postal_code":"","address_country":"","card_type":"","card_last_digits":"","card_expiration":"","communications_consent_email":"","communications_consent_phone":"","created_at":"","currently_employed":"","custom_field_responses":"<>","donation_amount":"","donations":"<>","donor_profile_id":"","email":"","employer_name":"","first_name":"","id":"","ip_address":"","last_name":"","middle_name":"","occupation":"","payment_method_type":"","phone":"","product_code":"","product_id":"","product_name":"","product_value":"","referrer":"","referrer_to_form":"","source_code":"","suffix":"","title":"","updated_at":"","utm_campaign":"","utm_content":"","utm_medium":"","utm_source":"","utm_term":""} ``` #### Donation Template ```json {"account_name":"","account_uid":"","action_page_id":"","action_page_name":"","address_city":"","address_country":"","address_line_1":"","address_line_2":"","address_region":"","address_postal_code":"","amount_in_dollars":"","check_number":"","commitment_recurring_until":"","commitment_uid":"","custom_field_responses":"<>","date":"","date_iso8601":"","donation":"<>","email":"","employer_name":"","event_amount":"","first_name":"","frequency":"","last_name":"","middle_name":"","name":"kb-article-module-5","net_amount":"","occupation":"","organization":"","origin":"","payment":"","payment_description":"","phone":"","prefix":"","processed_date":"","recurring":"","referrer":"","referrer_to_form":"","source_code":"","status":"","suffix":"","updated_at":"","utm_campaign":"","utm_content":"","utm_medium":"","utm_source":"","utm_term":""} ``` #### Commitment Template ```json {"id":"","total_amount_in_dollars":"","fund_allocations":"<>","next_capture_on":"","cancelled_on":"","token":"","frequency":"","action_page_id":"","action_page_name":"","donor_profile_id":"","payment_method_id":"","submission_id":"","created_at":"","updated_at":"","address_line_1":"","address_line_2":"","address_city":"","address_region":"","address_postal_code":"","address_country":"","email":"","phone":"","first_name":"","last_name":"","middle_name":"","occupation":"","employer_name":"","title":"","suffix":"","ip_address":"","referrer":"","referrer_to_form":"","communications_consent_email":"","communications_consent_phone":"","currently_employed":"","payment_status_message":"","changed_attributes":"<>","cancellation_reason":"","whodunnit":"","status":""} ``` ### Payload Data #### Request Headers ```json {"User-Agent":"Anedot-Hookshot/58c89d9","X-Request-Id":"a338c125-dc08-49ca-b554-d810b11d241f","X-Integration-Id":"253a6c61-e7a3-42f6-b42b-c0c397e37cdd","X-Integration-Event":"","X-Request-Signature":"cd5a0f7c316888b284b6212bccb92fb12eb34aab766d58d040b3b45a39fb2128"} ``` #### Request Body (Submission Created) ```json {"event":"submission_created","payload":{"id":"fb0e86ac-1655-4e40-bda1-a988c3557559","email":"admin@anedot.com","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":{"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"}} ``` #### Request Body (Submission Pledged) ```json {"event": "submission_pledged", "payload": {"id": "9f4b6cd1-08ba-4938-bce8-3f470ee9204f", "email": "admin@anedot.com", "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"}} ``` #### Request Body (Commitment Created) ```json {"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":"admin@anedot.com","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":{}}} ``` #### Request Body (Commitment Failed) ```json {"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": "gandalf@thegrey.com","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"}} ``` #### Request Body (Commitment Updated) ```json {"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": "gandalf@thegrey.com","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"}} ``` #### Request Body (Donation Completed) ```json {"event":"donation_completed","payload":{"date":"2023-05-19 21:16:55 UTC","name":"Annie Dot","email":"annie@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation ACH Returned) ```json {"event":"donation_ach_returned","payload":{"date":"2023-05-18 15:34:28 UTC","name":"Annie Dot","email":"admin@anedot.com","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":[],"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 \u2022\u2022\u2022\u2022 0021","custom_field_responses":{},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation Chargeback) ```json {"event":"donation_chargeback","payload":{"date":"2023-05-31 19:09:03 UTC","name":"Dr Annie Q Dot","email":"admin@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation Chargeback Reversed) ```json {"event":"donation_chargeback_reversed","payload":{"date":"2023-05-31 19:14:50 UTC","name":"Dr Annie Q Dot","email":"admin@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation Partially Refunded) ```json {"event":"donation_partially_refunded","payload":{"date":"2023-05-30 14:02:51 UTC","name":"Dr Annie Q Dot","email":"admin@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation Refunded) ```json {"event":"donation_refunded","payload":{"date":"2023-05-23 14:37:27 UTC","name":"Dr Annie Q Dot","email":"admin@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{"appeal_id":"W2207A1A","custom_flag_1":"WVT"},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` #### Request Body (Donation Settled) ```json {"event":"donation_settled","payload":{"donation":{"id":"db94ffdbebde37c85fb1b","settlement_date":"2023-01-19 22:12:11 UTC"}}} ``` #### Request Body (Donation Voided) ```json {"event":"donation_voided","payload":{"date":"2023-06-01 14:46:11 UTC","name":"Dr Annie Q Dot","email":"admin@anedot.com","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 \u2022\u2022\u2022\u2022 5454","custom_field_responses":{"number_of_tickets":"4"},"is_recurring_commitment":"false","commitment_recurring_until":"","communications_consent_email":"false","communications_consent_phone":"false"}} ``` *** ## Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ### Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://anedot.gitbook.io/anedot-docs/integrations/integration-automation-tools/webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.anedot.com/integrations/integration-automation-tools/webhooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.