Skip to content

docs: webhook tool execution modes - #132

Merged
Him188 merged 2 commits into
mainfrom
docs/webhook-execution-modes
Aug 11, 2026
Merged

docs: webhook tool execution modes#132
Him188 merged 2 commits into
mainfrom
docs/webhook-execution-modes

Conversation

@Him188

@Him188 Him188 commented Aug 11, 2026

Copy link
Copy Markdown
Contributor

Documents execution_mode (blocking / fire_and_forget / background) for webhook tools: mode comparison, background limits (300s timeout, 10 in-flight), and error-handling behavior per mode.

🤖 Generated with Claude Code


View with [code]smith Autofix with [code]smith
Need help on this PR? Tag @codesmith-bot with what you need. Autofix is disabled.

Summary by CodeRabbit

  • New Features

    • Webhook tools now support blocking, fire-and-forget, and background execution modes.
    • Background executions include configurable timeouts, cancellation, concurrency limits, and response delivery behavior.
    • Background tool timeouts can be configured for up to 300 seconds.
  • Documentation

    • Clarified error handling for fire-and-forget executions.
    • Added execution settings and background call limits to the limits reference.

…ground)

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@mintlify

mintlify Bot commented Aug 11, 2026

Copy link
Copy Markdown

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

Project Status Preview Updated (UTC)
hanabiaiinc 🟢 Ready View Preview Aug 11, 2026, 5:45 AM

💡 Tip: Enable Workflows to automatically generate PRs for you.

@coderabbitai

coderabbitai Bot commented Aug 11, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The webhook tools documentation adds three execution modes: blocking, fire_and_forget, and background. It documents background timeouts, cancellation, response delivery, error visibility, concurrency limits, and related webhook limits.

Changes

Webhook execution modes

Layer / File(s) Summary
Execution modes, timeouts, and limits
agents/build/webhook-tools.mdx
Documents execution mode selection and behavior, including background response handling, cancellation, text-only execution, failure visibility, timeout ranges, and concurrency limits. It also updates fire-and-forget error guidance and webhook limits.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely describes the documented webhook tool execution modes, which are the main focus of the changes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/webhook-execution-modes

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@agents/build/webhook-tools.mdx`:
- Line 94: Update the internal link in the text-only runs description to use the
relative target ../test/agent-tests instead of the root-relative
/agents/test/agent-tests, preserving the surrounding wording.
🪄 Autofix

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: 6f11821e-588d-49aa-80b3-bb5cce2eb9eb

📥 Commits

Reviewing files that changed from the base of the PR and between f16c7d2 and 56d345a.

📒 Files selected for processing (1)
  • agents/build/webhook-tools.mdx


- Up to **10 background calls** can be in flight per conversation. Further calls fail immediately with an error the agent can react to ("let me finish checking the first thing you asked about").
- When the conversation ends, in-flight background calls are cancelled; the attempt stays visible in the conversation's tool-call history.
- In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Use a relative path for the internal link.

Change /agents/test/agent-tests to ../test/agent-tests, relative to agents/build/webhook-tools.mdx. The current root-relative path does not follow the internal-link rule.

As per coding guidelines, use relative paths for internal links.

Proposed fix
-    - In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.
+    - In text-only runs — [agent tests](../test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- In text-only runs — [agent tests](/agents/test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.
- In text-only runs — [agent tests](../test/agent-tests), for example — every webhook tool executes as `blocking`, so results always appear in the transcript in order.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@agents/build/webhook-tools.mdx` at line 94, Update the internal link in the
text-only runs description to use the relative target ../test/agent-tests
instead of the root-relative /agents/test/agent-tests, preserving the
surrounding wording.

Source: Coding guidelines

@Him188
Him188 merged commit 678d194 into main Aug 11, 2026
7 checks passed
@Him188
Him188 deleted the docs/webhook-execution-modes branch August 11, 2026 05:48
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.

1 participant