Repository navigation
VAP15-54 docs: document subsystem server credentials - #1223
Draft
jeffrey-hoekman-vapi wants to merge 3 commits into
Draft
jeffrey-hoekman-vapi wants to merge 3 commits into
jeffrey-hoekman-vapi wants to merge 3 commits into
Conversation
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0a77d-e9cf-723d-9c6e-410c87ea8791.docs.buildwithfern.com |
|
|
||
| Some webhooks go to a URL owned by a subsystem rather than to your assistant's webhook URL - a tool, a knowledge base, a custom voice, a dynamic handoff or transfer destination, or a custom endpointing provider each carry their own `server` block: | ||
|
|
||
| | Webhook | Server it is sent to | |
There was a problem hiding this comment.
consider a one-dimensional list here, unless you feel that makes the behavior of function-call unclear
| "url": "https://api.example.com/intelligent-routing" | ||
| "url": "https://api.example.com/intelligent-routing", | ||
| "headers": { | ||
| "Authorization": "Bearer YOUR_API_KEY" |
There was a problem hiding this comment.
this should probably be renamed to distinguish it from the Vapi org API key. Maybe something like WEBHOOK_AUTH_SIGNATURE or OUTBOUND_PROVIDER_AUTH_KEY?
jeffrey-hoekman-vapi
force-pushed
the
jeffhoekman/vap15-53-webhook-credentials-withheld-caller-supplied-server-url
branch
from
September 16, 2026 18:01
056e643 to
a2c1858
Compare
jeffrey-hoekman-vapi
force-pushed
the
jeffhoekman/vap15-54-message-options-server-overrides
branch
from
September 16, 2026 18:22
cfe3c41 to
779ae5a
Compare
jeffrey-hoekman-vapi
changed the title
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0ab76-0f68-728c-bec7-e336ccaf48fe.docs.buildwithfern.com |
jeffrey-hoekman-vapi
force-pushed
the
jeffhoekman/vap15-54-message-options-server-overrides
branch
from
September 16, 2026 19:40
779ae5a to
76b3bd2
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0abbd-30ab-771e-a380-d100246fe0e4.docs.buildwithfern.com |
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0abbe-f072-7408-8b68-eb59beb6b5e6.docs.buildwithfern.com |
Extends VAP15-53 to the webhooks that go to a subsystem's own server rather than the assistant's webhook url - tools, knowledge bases, custom voices, dynamic handoff and transfer destinations, and custom endpointing providers. The rule is provenance inheritance: a subsystem server follows the assistant carrying it. A saved assistant keeps org credentials; a transient assistant or assistantOverrides is caller-authored and gets none. Calls out the mixed case, a saved assistant with an overridden voice, tools or knowledge base. Also gives the intelligent-routing handoff example an Authorization header. It was the only dynamic-destination example teaching a bare unauthenticated server url, directly under one that has auth. That content now lives in squads/handoff/destinations.mdx, which main split out of the handoff page. Provisional: VAPSEC-627 (#19542) is unreviewed and still changing. Re-verify the table and the inheritance rule against the merged behavior before this ships. Refs VAP15-54, VAPSEC-627 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Same §9 fix Steve applied across VAP15-53: a spaced hyphen standing in for a dash becomes a period, with the colon left to introduce the table. Also fixes the number disagreement the dash was hiding - "a tool, a knowledge base ... each carry" now reads as plurals throughout. Refs VAP15-54 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Withholding is decided per assistant: one caller-supplied server in assistantOverrides withholds the org credential from every subsystem request on that assistant, saved tools included. Add apiRequest and MCP requests, list what is withheld, document the second log entry, and rename the handoff example token placeholder. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
jeffrey-hoekman-vapi
changed the base branch from
jeffhoekman/vap15-53-webhook-credentials-withheld-caller-supplied-server-url
to
main
November 12, 2026 15:40
jeffrey-hoekman-vapi
force-pushed
the
jeffhoekman/vap15-54-message-options-server-overrides
branch
from
November 12, 2026 15:40
11f7f9f to
019d656
Compare
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a1d06c-b1b2-738b-946d-43db2074a2ea.docs.buildwithfern.com |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documents credential withholding for subsystem server URLs (tools, knowledge bases, custom voices, handoff and transfer destinations, custom endpointing,
apiRequesttools, and MCP), per VAPSEC-627.Draft, not ready to merge. The behavior lands with the VAPSEC-627 stack, which is still open.
Changes
fern/server-url/server-authentication.mdx, new#### Subsystem server URLssubsection:assistantOverridessupplies a server URL orcredentialIdfor any subsystem, the org credential is withheld from every subsystem request on that assistant whose URL differs from the webhook URL, including the saved assistant's own tools, voice, and knowledge basesecret/headers/ credential, a requestcredentialIdignored, the caller's ownsecretandheadersstill sent, payload redacted<Warning>on the saved-assistant consequence#### Confirming a withheld send in your logs: the second log entry,Assistant credentials withheld from <destination>: this assistant carries server configuration this request supplied.fern/squads/handoff/destinations.mdx: a<Warning>before the dynamic-handoff examples linking to that anchor, the missingAuthorizationheader on theintelligent-routingexample, andYOUR_API_KEYrenamed toYOUR_WEBHOOK_TOKENin both examples so it doesn't read as a Vapi API key.Merge gate
Merge only after all of these have merged:
<Note>for this section gets added here once that PR is up. Until then the 2026-09-23 Note above this section reads as if it applies here, so do not merge without it.Re-verify before merge
These come from the 627 PR descriptions, not from merged code:
variableValuesdon't trigger this": VapiAI/vapi#19542 also excludes aserverblock carrying onlysecret/headers; decide whether to document thatNotes
fern check: 0 errors, 15 warnings (pre-existing).mainafter VAP15-53 (VAP15-53 docs: document webhook credential withholding #1221) merged.Refs VAP15-54, VAPSEC-627, VAPSEC-792.
🤖 Generated with Claude Code