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 call.transferred webhook event is triggered whenever a call is transferred from the Apten assistant to another agent or system. This can be used to track call handoffs and monitor transfer patterns.
This event fires at transfer initiation, regardless of outcome. For warm transfers, subscribe to call.transfer.connected to be notified when the human agent successfully joins, and agentMissedTransfer to be notified when the agent does not answer.

​
Payload

{
  "event": "call.transferred",
  "data": {
    "leadId": "c4f23a1b-d8e5-4f67-90c1-2a5b8d3e9x7y",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+12025550189",
    "profile": "Default Profile",
    "callId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transferType": "WARM",
    "transferTo": "+12025550100"
  },
  "timestamp": "2024-01-15T14:30:00Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (call.transferred).
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.profilestringThe customer profile assigned to the lead.
data.callIdstringThe unique identifier for the call being transferred.
data.transferTypestringThe type of transfer: WARM (with introduction) or COLD (direct).
data.transferTostringThe phone number or identifier of the transfer destination.
timestampstringThe ISO 8601 timestamp when the call was transferred.