Successful payment webhook
When a payment is made successfully, an automation can be triggered. The payment details can be sent to the endpoint of your choice
Event Payload Fields
automationTrigger
string
Event type that triggered this action (successfulPayment)
contactId
string (UUID)
Donor / contact ID
paymentDate
number (timestamp)
Date of the payment (ms since epoch)
donorFirstName
string
Donor’s first name
donorLastName
string
Donor’s last name
string (email)
Donor’s email address
documentLanguage
string
Language for generated document (he, en)
donationCurrency
string (ISO 4217)
Currency of the donation
paymentType
string
Payment method type
donationSum
number
Amount donated
otherDescription
string
Additional donation description
isHok
boolean
Whether donation is part of a standing order
isInstallments
boolean
Whether donation is split into installments
accountId
string
Account ID associated with the donation
donationMethod
string
Method of donation
campaignId
string
Campaign ID associated with the donation
exchangeRate
number
Exchange rate applied
tz
string
Donor Israeli ID / company number
donorPersonalDedication
string
Personal dedication message from donor
donorDisplayName
string
Donor’s full display name
receiptEmail
string (email)
Email where receipt will be sent
donorPhoneNumber
string
Donor phone number
paymentId
string (UUID)
Payment record ID
agentId
string
Responsible agent or ambassador ID
journalId
string
Optional journal reference ID
donationFirstSum
number
First donation sum in recurring donation
donationSumInCampaignCurrency
number
Donation sum in campaign currency
splitAcrossMonths
number
Number of months to split donation across
managedExternally
boolean
Whether donation is managed externally
cancelled
boolean
Whether the donation was cancelled
updatedAt
number (timestamp)
Timestamp of last update
updatedByUserId
string (UUID)
ID of user who updated the record
purchaseTitle
string
Title of the donation / payment
customProperties
object
Donor custom fields (firstName, lastName, email, phone)
createdAt
number (timestamp)
Timestamp of record creation
donatedOn
number (timestamp)
Date when donation was actually made
marketingCampaignId
string
Optional marketing campaign ID
secondaryContactId
string
Optional secondary contact ID
status
string
Payment status
scheduleDate
number
Scheduled date for donation (optional)
nextBillingCycle
number
Timestamp of next billing cycle (if recurring)
failedReason
string
Reason for failed payment, if any
externalProviderSpecificFields
object
Fields specific to external payment provider
cc4dig
string
Last 4 digits of credit card (if applicable)
Last updated