docs: add data.error and data.error_omitted webhook fields and update max_response_payload_kbs description

[Pratham-Mishra04]

Summary

Extends webhook payloads for async_job.failed events to include the job's error body inline, mirroring the existing response/response_omitted behavior for successful jobs.

Changes

• Added data.error field to the webhook payload, which inlines the job's error body for async_job.failed events when include_response is set and the payload fits within max_response_payload_kbs.
• Added data.error_omitted field, set to true when the error body exceeds the size cap, directing consumers to fetch it via result_url instead.
• Updated max_response_payload_kbs descriptions in the docs, Helm chart schema, and transport config schema to reflect that the cap applies to both response and error payloads, and that oversized values are flagged with response_omitted or error_omitted accordingly.

Type of change

• Bug fix
• Feature
• Refactor
• Documentation
• Chore/CI

Affected areas

• Core (Go)
• Transports (HTTP)
• Providers/Integrations
• Plugins
• UI (React)
• Docs

How to test

Trigger an async job that fails and verify the webhook payload delivered to the endpoint includes data.error when the error body is within max_response_payload_kbs, and data.error_omitted: true when it exceeds the cap.

go test ./...

Breaking changes

• Yes
• No

Related issues

Security considerations

Error bodies may contain sensitive information. Consumers should treat data.error with the same care as data.response and ensure webhook endpoints are appropriately secured.

Checklist

• I read docs/contributing/README.md and followed the guidelines
• I added/updated tests where appropriate
• I updated documentation where needed
• I verified builds succeed (Go and UI)
• I verified the CI pipeline passes locally if applicable

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[Pratham-Mishra04]

• chore: remove WEBHOOK_EVENT_COLORS and sort events in webhook badges #5400
• docs: add data.error and data.error_omitted webhook fields and update max_response_payload_kbs description #5399 👈 (View in Graphite)
• feat: inline error/error_omitted fields in webhook payloads for failed async jobs #5398
• dev

This stack of pull requests is managed by Graphite. Learn more about stacking.

[coderabbitai]

Warning

Review limit reached

You’ve reached a temporary PR review limit under our Fair Usage Limits Policy.

Your recent review volume is higher than typical usage, so adaptive limits are currently applied.

Next review available in: 46 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: 2ba7c2ec-cdb5-4797-86ac-04977ddb3777

📥 Commits

Reviewing files that changed from the base of the PR and between 3099b9c and 9d2280b.

📒 Files selected for processing (3)

• docs/features/webhooks.mdx
• helm-charts/bifrost/values.schema.json
• transports/config.schema.json

📝 Walkthrough

Walkthrough

Webhook documentation and configuration schemas now describe failed-job error payload fields, shared response/error inline size limits, and the corresponding omission flags.

Changes

Webhook payload contracts

Layer / File(s)	Summary
Payload and schema documentation docs/features/webhooks.mdx, helm-charts/bifrost/values.schema.json, transports/config.schema.json	Documents data.error and data.error_omitted for failed async jobs, and updates max_response_payload_kbs descriptions to cover both response and error payloads with their omission flags.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Possibly related PRs

• maximhq/bifrost#5251: Introduces and validates per-endpoint webhook delivery tuning for max_response_payload_kbs.
• maximhq/bifrost#5269: Introduces the webhook feature documentation aligned by these updates.

Suggested reviewers: akshaydeo, danpiths

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
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.
Title check	✅ Passed	The title clearly matches the PR's main change: adding inline error webhook fields and updating payload size docs.
Description check	✅ Passed	The description follows the template and covers summary, changes, testing, impact, security, and checklist items.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch 07-21-docs_document_webhook_error_error_omitted_payload_fields

---

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

[greptile-apps]

Confidence Score: 5/5

This looks safe to merge.

• The documentation matches the existing inline error behavior.
• The transport and Helm schema descriptions remain aligned.
• No blocking issue was found in the changed code.

Important Files Changed

Filename	Overview
docs/features/webhooks.mdx	Documents failed-job error fields and the shared inline payload limit.
helm-charts/bifrost/values.schema.json	Clarifies that the Helm configuration limit covers response and error bodies.
transports/config.schema.json	Updates the source-of-truth configuration description to cover both payload types.

_{Reviews (2): Last reviewed commit: "docs: document webhook error/error_omitt..." | Re-trigger Greptile}

[Pratham-Mishra04]

Merge activity

• Jul 21, 4:44 AM UTC: A user started a stack merge that includes this pull request via Graphite.
• Jul 21, 4:47 AM UTC: Graphite rebased this pull request as part of a merge.
• Jul 21, 4:48 AM UTC: @Pratham-Mishra04 merged this pull request with Graphite.

The base branch was changed.