Repository navigation
docs: clarify transfer event coverage and initiation semantics - #1335
Conversation
Lightsage docs evalsLightsage could not queue docs evals for this PR. Docs URL: https://vapi-preview-01a1553c-ae48-712a-a420-1c47680b3bde.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1423b-73d4-726b-b05b-94f1b56d0b86.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a14593-be9d-70b9-91d9-e22319e57a5d.docs.buildwithfern.com |
stephenvapiai
left a comment
There was a problem hiding this comment.
A few wording suggestions.
Co-authored-by: Steve Smtih <stephen@vapi.ai>
Co-authored-by: Steve Smtih <stephen@vapi.ai>
Co-authored-by: Steve Smtih <stephen@vapi.ai>
Co-authored-by: Steve Smtih <stephen@vapi.ai>
|
🌿 Preview your docs: https://vapi-preview-01a1553c-53ca-709e-8732-e0a26c074fa5.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1553c-8a43-77ea-a17e-604260b74a2c.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1553c-caed-75fd-939e-539354b2ebbe.docs.buildwithfern.com |
|
🌿 Preview your docs: https://vapi-preview-01a1553c-ae48-712a-a420-1c47680b3bde.docs.buildwithfern.com |

Description
Problem: The server-events guide says
transfer-updatefires for every transfer, so customers can wait for a webhook that phone and SIP warm transfers never emit.This corrects the documented event coverage and explains which signal customers can use today.
fern/server-url/events.mdxwith the legacy assistant-destination behavior, valid nested payload excerpts, and thestatus-update/forwardingsignal for Vapi-managed phone and SIP transfers. Forwarding means initiation; it does not confirm an answer or successful handoff. Explain the Server URL and subscription requirements.fern/calls/assistant-based-warm-transfer.mdx, including that temporary transfer-assistant activation/restoration does not emittransfer-update.Verified against Vapi main
b84bc498e8525679cefab8b9552e891d32b1909e: voice-call emitter, phone/SIP forwarding and transport, transfer-assistant activation, and restoration. The broader message schema does not establish ringing/success/failure lifecycle events.Open question for Steve: Should a future runtime change extend
transfer-update, or use a separate event for actual started/connected/failed/canceled outcomes? Those are proposed semantics, not an existing contract, and are outside this docs-only PR.Testing Steps
messageenvelope. Fourteen unrelated existing placeholder snippets on the events page remain unchanged.transfer-updateanchor resolve to existing pages/headings.git diff --checkpasses; source facts and customer wording reviewed. No TS/JS changes.@vapi/server-sdk; the changed pages render successfully.