Skip to content

docs: add tool metadata documentation to webhook payload guides#873

Open
evantahler wants to merge 2 commits intomainfrom
evantahler/fix-issue-872
Open

docs: add tool metadata documentation to webhook payload guides#873
evantahler wants to merge 2 commits intomainfrom
evantahler/fix-issue-872

Conversation

@evantahler
Copy link
Contributor

@evantahler evantahler commented Mar 12, 2026

Adds comprehensive documentation for the new metadata field in webhook payloads introduced in monorepo PR #517. Updates both "Build Your Own" pages (contextual-access and logic-extensions) with a full Tool Metadata section including structure table, JSON examples for all hook types, and practical use cases.

Also updates stale GitHub repository URLs to canonical locations (oapi-codegen/oapi-codegen and openapi-ts/openapi-typescript).

Fixes #872.


Note

Low Risk
Documentation-only changes that update webhook payload descriptions and example JSON; no runtime code paths are affected.

Overview
Adds a new Tool Metadata section to the Build Your Own webhook server guides (Contextual Access and Logic Extensions), documenting the optional tool.metadata object (structure table, examples, and policy use cases).

Updates the pre/post/access hook request field descriptions to mention metadata is included when present, clarifies the toolkits request shape, and refreshes stale GitHub links for oapi-codegen and openapi-typescript.

Written by Cursor Bugbot for commit 78576e2. This will update automatically on new commits. Configure here.

Updated both "Build Your Own" pages (contextual-access and logic-extensions) to document the new optional metadata field in webhook payloads (PR #517). Added comprehensive Tool Metadata section including structure table, examples for pre/post/access hooks, and use cases. Updated external GitHub URLs to canonical repositories (oapi-codegen and openapi-ts).

Fixes #872.
@vercel
Copy link

vercel bot commented Mar 12, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 12, 2026 9:50pm

Request Review

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Style Review

Found 5 style suggestion(s).

Powered by Vale + Claude

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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.

Update 'Build Your Own' docs for tool metadata in webhook payloads

1 participant