Skip to content

docs: clarify transfer event coverage and initiation semantics - #1335

Merged
dhruva-vapi merged 6 commits into
mainfrom
dr/clarify-transfer-update-events
Oct 19, 2026
Merged

dhruva-vapi merged 6 commits into
mainfrom
dr/clarify-transfer-update-events

Conversation

@dhruva-vapi

@dhruva-vapi dhruva-vapi commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Description

Problem: The server-events guide says transfer-update fires 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.

  • Update fern/server-url/events.mdx with the legacy assistant-destination behavior, valid nested payload excerpts, and the status-update / forwarding signal 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.
  • Add a concise clarification and cross-reference in fern/calls/assistant-based-warm-transfer.mdx, including that temporary transfer-assistant activation/restoration does not emit transfer-update.
  • No navigation or runtime changes.

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

  • Pinned Fern validation: zero errors, 14 existing warnings (11 API path conflicts, 2 theme contrast warnings, 1 unauthenticated redirect check skipped).
  • Both added/changed JSON examples parse strictly and retain the HTTP message envelope. Fourteen unrelated existing placeholder snippets on the events page remain unchanged.
  • Added internal links and the transfer-update anchor resolve to existing pages/headings.
  • git diff --check passes; source facts and customer wording reviewed. No TS/JS changes.
  • Hosted preview build and Fern CI pass. Both changed pages verified through fetched rendered HTML (scripts excluded): corrected text, links, anchor, and valid nested payload examples. Preview. The preview build reports an existing TypeScript SDK snippet upload warning for @vapi/server-sdk; the changed pages render successfully.

@lightsage-app

lightsage-app Bot commented Oct 16, 2026 •

Copy link
Copy Markdown

Lightsage docs evals

Lightsage could not queue docs evals for this PR.

Docs URL: https://vapi-preview-01a1553c-ae48-712a-a420-1c47680b3bde.docs.buildwithfern.com
Commit: f3870be
Reason: No evals are selected for GitHub PR evals. Open Lightsage and enable the GitHub checkbox for at least one eval.

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@stephenvapiai stephenvapiai left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few wording suggestions.

Comment thread fern/server-url/events.mdx Outdated
Comment thread fern/server-url/events.mdx Outdated
Comment thread fern/server-url/events.mdx Outdated
Comment thread fern/calls/assistant-based-warm-transfer.mdx Outdated
dhruva-vapi and others added 4 commits October 19, 2026 10:34
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>
@dhruva-vapi
dhruva-vapi merged commit 26c3836 into main Oct 19, 2026
7 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

@github-actions

Copy link
Copy Markdown
Contributor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants