Skip to content

Document GraphQL webhook payload truncation and 10 MB size limit #1421

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
brianluong wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Document GraphQL webhook payload truncation and 10 MB size limit #1421

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec29258
Document GraphQL webhook payload truncation and 10 MB size limit
brianluong Jul 2, 2026
ac16822
Trim truncation docs to a concise FAQ entry per review feedback
brianluong Jul 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions .../api-reference/data/webhooks/custom-webhooks-quickstart/custom-webhooks-faq.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,16 @@ If you're seeing 5xx error codes when creating webhooks, please ensure that you

While logs and transactions can be self-referential entities, we only allow for a single-layer nested data structure to bound GraphQL queries. This helps us to to maintain a tidy API surface area.

## Why does my webhook payload have `truncated: true`?

Custom Webhook payloads are capped at 10 MB. If a block's query result exceeds the limit, we still deliver the webhook but truncate the result: list fields are cut to the elements that fit, and lists resolved after that come back empty. Truncated payloads include three extra fields inside `event`:

* `truncated` — `true` when the result is incomplete
* `truncatedFields` — the query field paths whose lists lost elements, for example `["block.logs", "block.logs.transaction.logs"]`
* `truncationReason` — a message naming the size limit that was exceeded

To stop receiving truncated payloads, narrow your query so the full result fits under the limit — `truncatedFields` shows exactly which selections to trim. The most common cause is nesting `transaction { logs }` under `block.logs`.

## How do I use the topic filter?

* Currently, our log/event filter leverages the same semantics as a traditional topic filter for an *eth\_getLogs* RPC call. If you're not familiar with how topic filters work for *eth\_getLogs*, here's [an article](/docs/deep-dive-into-eth_getlogs) to get you up to speed.
Expand Down
Loading