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.

​
Lead Tagged

This event occurs when a new lead is tagged by Apten. The webhook payload contains information about the lead that was tagged, including the lead’s id, phone number, communication channel (sms, email, call, or manual), and the associated tag. The tag name will match up to the name you define in the UI.

​
Payload

The following payload is sent when a lead is tagged: 
{
  "event": "leadTagged",
  "data": {
    "leadId": "a7e92c5d-f301-4b89-ae16-8f35d02cx9z",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+13305551234",
    "channel": "sms",
    "tag": "isQualified",
    "close_crm_leadId": "lead_xyz123"
  },
  "timestamp": "2024-02-18T09:45:22Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (leadTagged).
data.leadIdstringThe unique identifier for the lead.
data.externalLeadIdstringThe CRM lead ID (Salesforce, HubSpot, or Close CRM).
data.phonestringThe phone number of the lead.
data.channelstringThe communication channel. Can be sms, email, call, or manual.
data.tagstringThe tag applied to the lead. Matches the name defined in the UI.
data.close_crm_leadIdstringThe Close CRM lead ID. Only included if the lead is associated with Close CRM via integration.
timestampstringThe ISO 8601 timestamp when the lead was tagged.

​
Out-of-the-box Tags

By default, Apten sends events for a few tags out-of-the-box:
  • hasReplied
  • isHot
  • isQualified