VAP15-54 docs: document subsystem server credentials - #1223
Draft
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 |
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>
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 |
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>
Contributor
|
🌿 Preview your docs: https://vapi-preview-01a0abbe-f072-7408-8b68-eb59beb6b5e6.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
2 participants
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.
Stacked on #1221 (VAP15-53). Documents credential withholding for the subsystem server URL path — tools, knowledge bases, custom voices, dynamic handoff/transfer destinations, custom endpointing — per VAPSEC-627.
Draft, not ready to merge. The behavior this describes is VapiAI/vapi#19542, which is unreviewed with work outstanding.
Changes
fern/server-url/server-authentication.mdx— new#### Subsystem server URLssubsection: a table mapping each webhook to the server it is sent to, the provenance-inheritance rule, and a<Warning>on the mixed case (a saved assistant whose voice / tools / KB are replaced viaassistantOverridescarries caller-authored subsystem servers).fern/squads/handoff.mdx—<Warning>before the dynamic-handoff examples, linking to that anchor.fern/squads/handoff.mdx— added the missingAuthorizationheader to theintelligent-routingexample.Provisional — re-verify before merge
The prose asserts one rule — a subsystem server is caller-authored exactly when the assistant carrying it is — taken from the VAPSEC-627 Scope section and the PR title, not from merged code. The ticket notes the design is still open: a per-subsystem provenance bit was considered and rejected in favor of binding at the send site.
Before merging, re-check against the merged behavior:
assistantOverridesmixed case behaves as writtenserverCredentialGetcallers on the custom-voice path (firstMessageContext,liveCallFunctions.say) are in scopeMerge gate
Blocked by VAPSEC-627 / VapiAI/vapi#19542, which sits on top of the VAPSEC-564 stack. Merge order: 564 stack → VAP15-53 → 627 → this.
Notes
fern check: 0 errors, 12 pre-existing OpenAPI discriminator warnings (unrelated).ENFORCEMENT_DATE_TBDfrom the base branch — that is VAP15-53's placeholder, tracked there, not part of this diff.Refs VAP15-54, VAPSEC-627.
🤖 Generated with Claude Code