Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apten.ai/llms.txt

Use this file to discover all available pages before exploring further.

The lead.additionalInfo.updated webhook event is triggered when a lead’s additionalInfo object changes. This includes metadata you set via the API (for example on create or update) and values Apten stores on the lead over time. Use this event to sync CRM fields, trigger workflows, or audit changes without polling GET /leads/{leadId}.

​
Payload

The following payload is sent when one or more additionalInfo keys change on a lead: 
{
  "event": "lead.additionalInfo.updated",
  "data": {
    "leadId": "5b3e5a7d-2d2d-4bf3-be40-e384e879cce7",
    "phone": "+18134061816",
    "additionalInfo": {
      "insuranceProvider": {
        "old": null,
        "new": "Aetna"
      }
    }
  },
  "eventId": "5147f5c1a56fd3b1f31b8ca11da615dd",
  "timestamp": "2026-05-29T23:30:41Z"
}
Only keys that changed in that update appear under data.additionalInfo. Each key includes the previous and new value (null when a key was added or removed).

​
Example: key removed

{
  "event": "lead.additionalInfo.updated",
  "data": {
    "leadId": "5b3e5a7d-2d2d-4bf3-be40-e384e879cce7",
    "phone": "+18134061816",
    "additionalInfo": {
      "insuranceProvider": {
        "old": "Aetna",
        "new": null
      }
    }
  },
  "eventId": "a1b2c3d4e5f6789012345678abcdef01",
  "timestamp": "2026-05-29T23:35:00Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (lead.additionalInfo.updated).
data.leadIdstringThe unique identifier for the lead.
data.phonestringThe phone number of the lead.
data.additionalInfoobjectMap of changed keys. Each value is { old, new } where values are strings or null.
data.externalLeadIdstringThe CRM lead ID (Salesforce, HubSpot, or Close CRM). Only included when the lead is linked to a CRM.
data.close_crm_leadIdstringThe Close CRM lead ID. Only included when the lead is associated with Close CRM via integration.
eventIdstringStable identifier for this change.
timestampstringThe ISO 8601 timestamp when the webhook was sent.