transfer_started

Triggered when a call transfer starts.

About This Event

The transfer_started webhook is triggered when Altur records that a call transfer handoff has started. Use it to prepare real-time context for the human agent who may receive the transferred call.

Event Details

• Trigger: Automatically triggered when the transfer handoff starts.
• Purpose: To notify your backend or CRM before the human transfer leg connects.

Request Details

• HTTP Method: POST
• Content Type: application/json
• Endpoint: The URL you configure in your webhook integration settings.
• Authentication: Includes the X-Altur-Signature header for HMAC verification.

Payload Example

{
  "event_type": "transfer_started",
  "id": "cll_gBoLtd02pUI50QwXkFjB",
  "thread_id": "thr_Kp7mQz3XvNb8LcRt2sYw",
  "type": "outbound",
  "status": "in-progress",
  "phone_number_from": "+000000000000",
  "phone_number_to": "+000000000000",
  "answered_by": "human",
  "created_at": "2024-12-19T15:00:10Z",
  "started_at": "2024-12-19T15:00:12Z",
  "ended_at": null,
  "ended_by": null,
  "ended_reason": null,
  "transfer_initiated_at": "2024-12-19T15:01:00Z",
  "transfer_completed_at": null,
  "duration": null,
  "billed_duration": null,
  "recording_url": "https://api.altur.io/api/v1.0/call/cll_gBoLtd02pUI50QwXkFjB/recording",
  "transcript": [],
  "assistant": {
    "id": "6cy951e6-9877-4d7c-88d7-56b4948d3cce",
    "nickname": "DebtCollectorBot",
    "name": "Diana Arroyo"
  },
  "end_user": {
    "id": "2be951e6-7798-47cd-878d-49b2918a3bba",
    "status": "converted",
    "display_name": "John Doe",
    "phone_number": "[phone]",
    "context": "Customer data...",
    "extracted_data": {},
    "tags": ["call_later"]
  },
  "campaign_user": {
    "f_id": "user_12345",
    "name": "John Doe",
    "contact": "[phone]",
    "context": "Customer data for campaign...",
    "status": "converted",
    "failed_retries": 0,
    "voicemail_retries": 1,
    "extracted_data": {},
    "tags": ["call_later"]
  }
}

Transfer Fields

Field	Type	Description
event_type	string	transfer_started.
transfer_initiated_at	datetime	ISO timestamp when Altur recorded the transfer handoff starting.
transfer_completed_at	datetime	Usually null for this event.

All other fields match the on_call_end call payload.

The payload describes the call at the moment of the transfer: status is in-progress, answered_by is human, and ended_at, ended_by, ended_reason, duration and billed_duration are null. The transcript contains the messages Altur has received up to the transfer; the last few lines spoken right before the transfer may occasionally be missing. Use on_call_end for the full transcript. The end_user and campaign_user objects reflect their values when the event is sent.

Transfer webhooks do not support filters.

Response Expectations

Your endpoint should return a 200 OK status code to confirm receipt. For retry behavior, see the Retry Policy.