docs: add proxy webhook guardrail documentation - #1052
Open
akhilmmenon wants to merge 2 commits into
Open
akhilmmenon wants to merge 2 commits into
akhilmmenon wants to merge 2 commits into
Conversation
…on in BYOG, Guardrail Checks and Changelog
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
There was a problem hiding this comment.
🟢 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
executeOnProxyand 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.
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.
Summary
executeOnProxyparameter for webhook guardrails, enabling webhook checks on proxy (/v1/*) passthrough requestsrequestInfofield (method,path,contentType) to the webhook request body schema andproxyas a newrequestTypevalueRelated Gateway PR: https://github.com/Portkey-AI/gateway/pull/1920
Changes
integrations/guardrails/bring-your-own-guardrails.mdxExecute on Proxyto parameters table,executeOnProxyin inline config example,requestInfoobject in request body schema,proxyrequestType, new "Webhook Guardrails on Proxy Requests" section, transform caveat notesproduct/guardrails/list-of-guardrail-checks.mdxexecuteOnProxy: booleanto Webhook row parameterschangelog/enterprise.mdxTest plan