Event Type
lead.updated
Description
This event is fired when lead fields or checklist items are updated. The payload is sparse — it only includes fields that changed, along withleadId and externalId which are always present.
Payload Structure
The event type:
lead.updatedThe updated lead data (sparse — only changed fields included)
Show data
Show data
Unique identifier for the lead
External identifier for the lead (if set)
Lead’s first name (only included if changed)
Lead’s middle name (only included if changed)
Lead’s last name (only included if changed)
Lead’s phone number (only included if changed)
Lead’s email address (only included if changed)
Lead’s business name (only included if changed)
Lead’s website URL (only included if changed)
Array of updated checklist items (only included if checklist items changed)
Show checklistItems
Show checklistItems
ID of the checklist item definition
Code identifier for the checklist item
Current value of the checklist item. Type depends on the field type:
string for text fields, number for numeric fields, or an address object with the following structure: { "street": "...", "city": "...", "state": "...", "postalCode": "...", "country": "..." }.Status of the checklist item:
TODO, COMPLETED, INVALID, SKIPPED, NEEDS_REVIEWISO 8601 timestamp of the last update
Array of documents associated with the checklist item (only for file-type fields)
Show documents
Show documents
Unique identifier for the document
External identifier for the document
Original filename
MIME type of the document
File size in bytes
S3 bucket name (only included if external S3 integration is configured)
S3 object key (only included if external S3 integration is configured)
Document validation results (if validation rules are configured)
Show validationResult
Show validationResult
ID of the validated document
Whether the document passed all validation rules
Additional notes from validation
ID of the associated checklist item
Whether the document passed all validation rules
Copy
{
"event": "lead.updated",
"data": {
"leadId": "50713355-df73-4077-9d84-dcda6da5729c",
"externalId": "ext-lead-001",
"email": "newemail@example.com",
"checklistItems": [
{
"checklistItemId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"checklistItemCode": "bank_statement",
"value": "bank-statement-june.pdf",
"alternateValues": [],
"status": "NEEDS_REVIEW",
"updatedAt": "2025-10-31T19:00:01.675Z",
"documents": [
{
"documentId": "8349efe7-3c68-49c3-9411-f9affda0d03a",
"externalId": null,
"filename": "bank-statement-june.pdf",
"mimeType": "application/pdf",
"size": 153143,
"validationResult": {
"documentId": "8349efe7-3c68-49c3-9411-f9affda0d03a",
"overallValid": false,
"otherNotes": "Document shows account holder name as 'JOHN DOE'.",
"validationResults": [
{
"isValid": true,
"ruleName": "First name should match",
"ruleIndex": 0,
"isValidReason": "Lead first name 'John' matches document name 'JOHN'."
},
{
"isValid": false,
"ruleName": "Statement must be dated within the last 3 months",
"ruleIndex": 1,
"isValidReason": "June 2025 is outside the required period. Valid months are October 2025, September 2025, August 2025."
}
],
"leadChecklistItemId": "f830cc29-16ad-4c64-9fa8-f90f318f8dce"
},
"overallValid": false
}
]
}
]
}
}