Ambassador goal reached webhook
When an ambassador reaches their goal, an automation can be triggered. The goal and ambassador details can be sent to the endpoint of your choice
Event Payload Fields
automationTrigger
string
Event type that triggered this action (ambassadorTarget)
contactId
string (UUID)
Ambassador contact ID
paymentDate
number (timestamp)
Date of the donation (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 the document
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 is 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)
sum
number
Donation sum
currency
string
Donation currency
additionalRecurringMonths
number
Extra months for recurring donation
additionalRecurringSum
number
Extra sum for recurring donation
telephone
string
Ambassador phone number
firstName
string
Ambassador first name
lastName
string
Ambassador last name
lang
string
Language code of ambassador
linkId
string
Unique link identifier for ambassador message
customSecondaryProperties
object
Optional secondary custom properties
contactProperties
object
Additional contact properties
updateContactFieldsConfig
object
Configuration for updating contact fields
futureCommitment
boolean
Whether donor committed to future donations
internalComments
string
Internal comments regarding donation or ambassador
complete
boolean
Whether donation processing is complete
createReceipt
boolean
Whether to create a receipt automatically
requiresTracking
boolean
Whether donation requires tracking
createHistoricalTransactions
boolean
Whether historical transactions are generated
firstSum
number
First payment sum
paypalSubscriptionId
string
Optional PayPal subscription ID
paypalOrderId
string
Optional PayPal order ID
webhook
string
Webhook URL triggered by donation
paymentCategory
string
Category of payment
chargeDay
number
Day of month for recurring charge
transactionResult
string
Result of transaction
authNumber
string
Authorization number for payment
transactionRef
string
Transaction reference ID
clearingProcessor
string
Payment clearing processor
backend
boolean
Whether action is triggered from backend
source
string
Optional source information
externalTransactionId
string
External payment ID
externalSubscriptionId
string
External subscription ID
externalReceiptCreated
boolean
Whether external receipt is already created
skipTransactionCreation
boolean
Skip creating transaction in system
masavBusinessName
string
Business name for MASAV payment (if any)
importContactId
string
Imported contact ID (if any)
splitAccountV2
string
Account split information
isPurchase
boolean
Marks if the payment is a purchase
paymentMethodId
string (UUID)
Payment method ID
receiptMethodId
string
Receipt method ID
isFormSubmission
boolean
Whether this came from a form submission
fullSum
number
Full sum of donation
ambassadorId
string
Ambassador ID related to donation
exchangeRateToUSD
number
Exchange rate to USD
completed
boolean
Whether the donation process is completed
items
array
Items associated with donation
partition
string
Database partition key
paymentMethodSource
string
Source of the payment method
alertDate
number
Alert date for the action
apiSource
string
Source API endpoint
createdDate
number
Record creation date
duplicateKey
string
Duplicate detection key
firstNameLower
string
First name in lowercase
hasActiveHok
boolean
Ambassador has active HOK / recurring donations
hasDonated
boolean
Ambassador has donated before
holding
boolean
Holding flag
holdingTime
number
Duration of holding in ms
ignoreDedupe
boolean
Whether deduplication should be ignored
importId
string (UUID)
Import ID of the contact
initialClosenessRating
number
Initial closeness rating
isAmbassador
string
Whether the contact is an ambassador
isContactImport
boolean
Imported as contact
isPaymentImport
boolean
Imported as payment
lastCallTime
number
Last call timestamp
lastNameLower
string
Last name in lowercase
mainAgent
string
Main agent responsible for ambassador
nextAllowedCallTime
number
Next allowed call timestamp
rating
number
Ambassador rating
requestedNoCalls
boolean
Whether ambassador requested no calls
segment
number
Segment ID
skipEmailTelephoneCheck
boolean
Skip email/phone verification
storedBillingMethod
array
Stored billing methods
AMBASSADOR_LINK_HE
string (URL)
Ambassador link in Hebrew
ambassadorLink
string
Ambassador unique link identifier
AMBASSADOR_TARGET_LINK
string
Target link identifier
AMBASSADOR_STATS_LINK
string (URL)
Link to ambassador stats page
AMBASSADOR_AMOUNT_RAISED_LINK
number
Total amount raised via ambassador
AMBASSADOR_PERCENT_RAISED_LINK
string
Percent of target raised
AMBASSADOR_PRECENT_RAISED_LINK
string
Percent raised field, different types (if applicable)
DONOR_NAME_TOKEN_LINK
string
Donor display name token
AMBASSADOR_TARGET
string
Target campaign ID
AMBASSADOR_STATS
string (URL)
Ambassador stats page URL
AMBASSADOR_AMOUNT_RAISED
number
Amount raised by ambassador
AMBASSADOR_PERCENT_RAISED
string
Percent raised by ambassador
DONOR_NAME_TOKEN
string
Donor display name
Last updated