Skip to content

docs: add proxy webhook guardrail documentation - #1052

Open
akhilmmenon wants to merge 2 commits into
mainfrom
feat/proxy-webhook-guardrail
Open

akhilmmenon wants to merge 2 commits into
mainfrom
feat/proxy-webhook-guardrail

Conversation

@akhilmmenon

@akhilmmenon akhilmmenon commented Sep 2, 2026

Copy link
Copy Markdown
Member

Summary

  • Documents the new executeOnProxy parameter for webhook guardrails, enabling webhook checks on proxy (/v1/*) passthrough requests
  • Adds requestInfo field (method, path, contentType) to the webhook request body schema and proxy as a new requestType value
  • Documents proxy-specific limitations: deny-only mode (transforms ignored), JSON-only content type requirement, and all-checks-must-opt-in constraint
  • Updates the guardrail checks list and enterprise changelog entry

Related Gateway PR: https://github.com/Portkey-AI/gateway/pull/1920

Changes

File What changed
integrations/guardrails/bring-your-own-guardrails.mdx Added Execute on Proxy to parameters table, executeOnProxy in inline config example, requestInfo object in request body schema, proxy requestType, new "Webhook Guardrails on Proxy Requests" section, transform caveat notes
product/guardrails/list-of-guardrail-checks.mdx Added executeOnProxy: boolean to Webhook row parameters
changelog/enterprise.mdx Expanded v2.20.0 entry with deny-only and JSON-only details, updated link to new proxy-specific section

Test plan

  • Verified rendered output via Mintlify preview in PR

@mintlify

mintlify Bot commented Sep 2, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
portkey-docs 🟢 Ready View Preview Sep 2, 2026, 9:34 AM

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Approval recommended

The documentation is consistent, complete, and correctly cross-linked.

Pull request overview

Documents proxy-route support for webhook guardrails across integration docs, guardrail references, and enterprise release notes.

Changes:

  • Documents executeOnProxy and proxy webhook payload metadata.
  • Explains deny-only, JSON-only, and opt-in constraints.
  • Links the enterprise changelog to the detailed guide.
File summaries
File Description
integrations/guardrails/bring-your-own-guardrails.mdx Adds proxy configuration, schema, examples, and limitations.
product/guardrails/list-of-guardrail-checks.mdx Lists the new webhook parameter.
changelog/enterprise.mdx Expands and links the proxy webhook release entry.
Review details
  • Files reviewed: 3/3 changed files
  • Comments generated: 0
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

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