Skip to main content
The webchat.call.transferred webhook event is triggered when a transfer call happens in a webchat session. This event fires instead of the lead-webhook call.transferred event for webchat-originated calls.

​
Payload

{
  "event": "webchat.call.transferred",
  "data": {
    "sessionId": "550e8400-e29b-41d4-a716-446655440000",
    "orgId": "org-abc123",
    "profile": "Default Profile",
    "origin": "https://example.com/pricing",
    "callId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "transferType": "WARM",
    "transferTo": "+12025550100"
  },
  "timestamp": "2024-01-15T14:30:00Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (webchat.call.transferred).
data.sessionIdstringThe unique identifier for the webchat session.
data.orgIdstringThe Apten organization ID that owns the session.
data.profilestringThe name of the webchat profile that handled the session.
data.originstringThe URL of the page where the webchat widget was opened. Only included if set.
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 webhook was sent.