What Will We Learn Here?
A Webhook is Jgive's way of "talking" to your other systems.
Think of it as a "Smart Notification": whenever an action occurs on the site (like a new donation), our system automatically sends the data to your system in real-time, without you needing to check the data manually.
Before We Start
To enable the Webhook, you need a dedicated URL address where the data will be sent.
Have a URL? Great, proceed to the next steps.
Don't have a URL? We recommend contacting a developer or your automation specialist to generate the appropriate link for you.
Steps to Set Up the Webhook
Enter the Organization Area.
Click on "Account Settings" in the side menu.
At the top of the screen, switch to the "Integrations" tab.
Locate the field labeled Webhook URL.
Paste the address you created (or received from your developer) into this field.
Click "Save".
🧾 Donation Webhook Event - Field Descriptions
🔹 transfer – Payment transfer details
Field | Description |
id | Unique ID of the transfer |
completed_at | Timestamp when the transfer was completed |
refunded_at | Timestamp if the transfer was refunded |
israeli_id | Donor’s Israeli ID used in the transfer |
israeli_id_source | Source from which the Israeli ID was obtained |
amount | Transfer amount |
currency | Currency of the transfer amount |
🔹 donation – Metadata about the donation
Field | Description |
donation_id | Unique ID of the donation |
created_at | Timestamp when the donation was created |
comment | Optional comment left by the donor |
share_donor_details_with_charities | Whether donor agreed to share their details with charities |
receive_updates_from_charities | Whether donor agreed to receive updates from charities |
purpose_he | Purpose of the donation (Hebrew) |
purpose_en | Purpose of the donation (English) |
checkout_locale | Language used during the donation checkout |
recurring | Indicates if the donation is recurring |
recurring_months | Duration of the recurring donation in months |
upcoming_transfer_count | Number of remaining transfers (if recurring) |
next_transfer_at | Next scheduled transfer date (if recurring) |
recurring_end_date | End date of recurring donations |
recurring_payment_number | Current payment number in the recurring cycle |
amount | Donation amount |
norm_amount | Normalized donation amount |
amount_currency | Currency of the donation |
🔹 payment_method – Payment method used
Field | Description |
provider | Payment provider used (e.g., PayMe) |
name | Type of payment method (e.g., credit card) |
card_last4 | Last 4 digits of the card used |
redirected | Whether the user was redirected during payment |
🔹 invoice – Invoice details
Field | Description |
id | Unique ID of the invoice |
number | Invoice number issued |
download_url | URL to download the original invoice PDF |
download_copy_url | URL to download a copy of the invoice |
tax_authority_confirmation_number | Confirmation number from tax authority (if any) |
🔹 donor – Donor's personal information
Field | Description |
Donor's email address | |
phone_number | Donor's phone number |
israeli_id | Donor's Israeli ID |
first_name | Donor’s first name |
last_name | Donor’s last name |
full_name | Donor’s full name |
🔹 invoice_information – Billing info for the invoice
Field | Description |
recipient_name | Name that appears on the invoice |
company_id | Company ID (if a business invoice) |
address_1 | First address line |
address_2 | Second address line (if applicable) |
🔹 donation_target – Recipient of the donation (e.g. participant, team, event)
Field | Description |
id | Unique ID of the donation target |
name_he | Target name in Hebrew |
name_en | Target name in English |
to_charity_page | Was the donation to a charity page? |
to_main_event | Was the donation to a main event? |
to_team | Was the donation to a team page? |
team_id | Associated team ID (if applicable) |
main_event_id | Associated main event ID |
🔹 participant – Participant related to the donation
Field | Description |
id | Unique ID of the participant |
name_he | Participant's name in Hebrew |
name_en | Participant's name in English |
Participant's email | |
phone_number | Participant’s phone number |
send_email_notification | Whether to send an email notification |
send_whatsapp_notification | Whether to send a WhatsApp notification |
team_id | Team ID linked to the participant (if any) |
main_event_id | Main event the participant is part of |