Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
stephenvapiai merged 2 commits into from
Oct 14, 2026
Merged

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2a0dd38
docs: fix tool-calls example payload shape on the Server URL events page
chiranjeet-vapi Oct 14, 2026
8e5ed99
Merge branch 'main' into docs/tool-calls-webhook-payload-shape
stephenvapiai Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 33 additions & 15 deletions fern/server-url/events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,17 +49,20 @@ Example assistant configuration (excerpt):
"model": {
"provider": "openai",
"model": "gpt-4o",
"functions": [
"tools": [
{
"name": "sendEmail",
"description": "Used to send an email to a client.",
"parameters": {
"type": "object",
"properties": {
"emailAddress": { "type": "string" },
"message": { "type": "string" }
},
"required": ["emailAddress", "message"]
"type": "function",
"function": {
"name": "sendEmail",
"description": "Used to send an email to a client.",
"parameters": {
"type": "object",
"properties": {
"emailAddress": { "type": "string" },
"message": { "type": "string" }
},
"required": ["emailAddress", "message"]
}
}
}
]
Expand All @@ -74,14 +77,29 @@ When tools are triggered, your Server URL receives a `tool-calls` message:
"message": {
"type": "tool-calls",
"call": { /* Call Object */ },
"toolWithToolCallList": [
"toolCallList": [
{
"name": "sendEmail",
"toolCall": { "id": "abc123", "parameters": { "emailAddress": "john@example.com", "message": "Hi!" } }
"id": "abc123",
"type": "function",
"function": {
"name": "sendEmail",
"arguments": { "emailAddress": "john@example.com", "message": "Hi!" }
}
}
],
"toolCallList": [
{ "id": "abc123", "name": "sendEmail", "parameters": { "emailAddress": "john@example.com", "message": "Hi!" } }
"toolWithToolCallList": [
{
"type": "function",
"function": { "name": "sendEmail", "parameters": { /* tool parameters schema */ } },
"toolCall": {
"id": "abc123",
"type": "function",
"function": {
"name": "sendEmail",
"arguments": { "emailAddress": "john@example.com", "message": "Hi!" }
}
}
}
]
}
}
Expand Down
Loading