Call Transferred

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. Once your team has taken the visitor over, you can stop Apten from converting the session into a lead and following up by calling Disable webchat auto-conversion with data.sessionId.

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

Property	Type	Description
`event`	string	The webhook event type (`webchat.call.transferred`).
`data.sessionId`	string	The unique identifier for the webchat session.
`data.orgId`	string	The Apten organization ID that owns the session.
`data.profile`	string	The name of the webchat profile that handled the session.
`data.origin`	string	The URL of the page where the webchat widget was opened. Only included if set.
`data.callId`	string	The unique identifier for the call being transferred.
`data.transferType`	string	The type of transfer: `WARM` (with introduction) or `COLD` (direct).
`data.transferTo`	string	The phone number or identifier of the transfer destination.
`timestamp`	string	The ISO 8601 timestamp when the webhook was sent.

Get Started

Account & Security

Tutorials

Compliance

Webhooks

Integrations

Webchat

Automations

Call Transferred

Payload

Properties

​Payload

​Properties

Payload

Properties