Skip to content

docs: fix tool-calls example payload shape on the Server URL events page - #1320

Merged
stephenvapiai merged 2 commits into
VapiAI:mainfrom
chiranjeet-vapi:docs/tool-calls-webhook-payload-shape
Oct 14, 2026
Merged

stephenvapiai merged 2 commits into
VapiAI:mainfrom
chiranjeet-vapi:docs/tool-calls-webhook-payload-shape

Conversation

@chiranjeet-vapi

Copy link
Copy Markdown
Contributor

Description

  • The tool-calls example on fern/server-url/events.mdx shows toolCallList entries as { id, name, parameters } and toolWithToolCallList entries as { name, toolCall: { id, parameters } }. Neither matches the API schema or fern/tools/custom-tools.mdx.
  • toolCallList entries are now { id, type: "function", function: { name, arguments } }; toolWithToolCallList entries carry type, function and toolCall.
  • The assistant example above it used model.functions, which is not a property of any model schema; it now uses model.tools with type: "function".

Evidence

Live spec (https://api.vapi.ai/api-json, 2026-10-14):

ToolCall                   required: id, type, function
ToolCallFunction           properties: name, arguments
FunctionToolWithToolCall   required: type, toolCall
OpenAIModel                has "tools": true, has "functions": false

Testing Steps

  • fern check (pinned 5.151.1) passes locally
  • Check the preview deployment for the changed page

toolCallList entries are { id, type, function: { name, arguments } } and
toolWithToolCallList entries carry type, function and toolCall, matching
the ToolCall and FunctionToolWithToolCall schemas and the custom tools page.
The assistant example now uses model.tools; model.functions is not in the
API schema.
@chiranjeet-vapi
chiranjeet-vapi marked this pull request as ready for review October 14, 2026 16:41
@lightsage-app

lightsage-app Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Lightsage docs evals

Waiting for the staging docs URL before running evals.

Lightsage will start the selected PR evals automatically when GitHub reports a successful docs deployment for this PR. This usually happens within 15 minutes.

Commit: 8e5ed99
Status: waiting for staging docs URL

@stephenvapiai
stephenvapiai self-requested a review October 14, 2026 16:50
@stephenvapiai
stephenvapiai merged commit 8b2a76c into VapiAI:main Oct 14, 2026
2 of 6 checks passed
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