Repository navigation
Commit a2c1858
VAP15-53 docs: document webhook credential withholding
VAPSEC-564/619/623 changed a documented contract: when a server URL
arrives in the API request itself - a transient assistant, or
assistantOverrides - Vapi no longer attaches the org's webhook
credential, and credential fields in the payload arrive as [REDACTED].
The page still promised the old behavior, so a customer hitting this
sees an unauthenticated webhook and no explanation, indistinguishable
from a broken listener.
Adds three things to fern/server-url/server-authentication.mdx:
- A Quick start warning, so the "Vapi will now authenticate requests"
promise carries its condition where a reader meets it rather than 300
lines later.
- A "When credentials are not attached" section: which paths are
caller-authored, the contrast that saved assistants, phone numbers and
tools keep their credentials, and the [REDACTED] payload note.
- "Confirming a withheld send in your logs", carrying what support
needs: the literal log string, the suppressed high-volume message
types, and the trap that a missing entry does not mean credentials
were sent.
The rollout qualifier is not optional polish. Without it the page states
the withholding unconditionally while pre-cutoff orgs are still gated by
ENABLE_WEBHOOK_CREDENTIAL_BINDING, so an unenrolled org could read "no
X-Vapi-Secret header" and conclude its secret is not reaching a
third-party URL when it still is - an inaccuracy in the unsafe
direction. It deliberately does not invite enrollment requests; the ramp
is a hand-maintained list with limited slots, mostly allocated.
ENFORCEMENT_DATE_TBD is a literal placeholder and a merge blocker. The
VAPSEC-689 cutoff is still being settled with the CISO, infosec and the
EM. A non-rendering MDX comment marks the spot.
Scoped to the webhook server URL. The message-options override paths
(tools, KB, custom voice, handoff and transfer destinations,
endpointing) are VAPSEC-627 and are documented separately in VAP15-54.
fern check: 0 errors, 12 pre-existing discriminator warnings.
Refs VAP15-53, VAPSEC-564, VAPSEC-619, VAPSEC-623, VAPSEC-689
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>1 parent 786d1a2 commit a2c1858
1 file changed
Lines changed: 44 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
57 | 57 | | |
58 | 58 | | |
59 | 59 | | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
60 | 64 | | |
61 | 65 | | |
62 | 66 | | |
| |||
380 | 384 | | |
381 | 385 | | |
382 | 386 | | |
| 387 | + | |
| 388 | + | |
| 389 | + | |
| 390 | + | |
| 391 | + | |
| 392 | + | |
| 393 | + | |
| 394 | + | |
| 395 | + | |
| 396 | + | |
| 397 | + | |
| 398 | + | |
| 399 | + | |
| 400 | + | |
| 401 | + | |
| 402 | + | |
| 403 | + | |
| 404 | + | |
| 405 | + | |
| 406 | + | |
| 407 | + | |
| 408 | + | |
| 409 | + | |
| 410 | + | |
| 411 | + | |
| 412 | + | |
| 413 | + | |
| 414 | + | |
| 415 | + | |
| 416 | + | |
| 417 | + | |
| 418 | + | |
| 419 | + | |
| 420 | + | |
| 421 | + | |
| 422 | + | |
| 423 | + | |
| 424 | + | |
| 425 | + | |
| 426 | + | |
383 | 427 | | |
384 | 428 | | |
385 | 429 | | |
| |||
0 commit comments