Skip to content

docs: update webhook parameter filtering types and add example #7295

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.

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
wants to merge 1 commit into
base: fix_make_contract_and_to_addresses_optional_in_webhook_form
Choose a base branch
from

Conversation

catalyst17
Copy link
Contributor

@catalyst17 catalyst17 commented Jun 6, 2025

[Portal] Fix: Update webhook parameter filtering documentation

Notes for the reviewer

This PR updates the webhook filtering documentation to:

  1. Correct the type definition for params in both events and transactions filters
  2. Add a practical example showing how to filter for Transfer events with specific parameters

How to test

Review the updated documentation to ensure the type definitions are correct and the new example is clear and helpful.


PR-Codex overview

This PR updates the params property in the webhooks filtering configuration to allow for stricter type definitions, changing it from Record<string, any> to Record<string, string | number>. It also provides an example of how to filter Transfer events.

Detailed summary

  • Changed params type in the webhooks filtering from Record<string, any> to Record<string, string | number>.
  • Updated params type in the signatures object from string[] to Record<string, string | number>.
  • Added an example for filtering Transfer events with a specific from address.

✨ Ask PR-Codex anything about this PR by commenting with /codex {your question}

@vercel vercel bot temporarily deployed to Preview – login June 6, 2025 13:49 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 6, 2025 13:49 Inactive
Copy link

vercel bot commented Jun 6, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 6, 2025 2:32pm
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
login ⬜️ Skipped (Inspect) Jun 6, 2025 2:32pm
thirdweb_playground ⬜️ Skipped (Inspect) Jun 6, 2025 2:32pm
thirdweb-www ⬜️ Skipped (Inspect) Jun 6, 2025 2:32pm
wallet-ui ⬜️ Skipped (Inspect) Jun 6, 2025 2:32pm

@vercel vercel bot temporarily deployed to Preview – thirdweb-www June 6, 2025 13:49 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 6, 2025 13:49 Inactive
Copy link

changeset-bot bot commented Jun 6, 2025

⚠️ No Changeset found

Latest commit: 8fe01c7

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

coderabbitai bot commented Jun 6, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link
Contributor Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more


How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

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

@github-actions github-actions bot added the Portal Involves changes to the Portal (docs) codebase. label Jun 6, 2025
@catalyst17 catalyst17 marked this pull request as ready for review June 6, 2025 13:50
@catalyst17 catalyst17 requested review from a team as code owners June 6, 2025 13:50
Copy link

codecov bot commented Jun 6, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 55.58%. Comparing base (a176c4d) to head (8fe01c7).

Additional details and impacted files
@@                                     Coverage Diff                                      @@
##           fix_make_contract_and_to_addresses_optional_in_webhook_form    #7295   +/-   ##
============================================================================================
  Coverage                                                        55.58%   55.58%           
============================================================================================
  Files                                                              909      909           
  Lines                                                            58670    58670           
  Branches                                                          4158     4158           
============================================================================================
  Hits                                                             32609    32609           
  Misses                                                           25954    25954           
  Partials                                                           107      107           
Flag Coverage Δ
packages 55.58% <ø> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copy link
Contributor

github-actions bot commented Jun 6, 2025

size-limit report 📦

Path Size Loading time (3g) Running time (snapdragon) Total time
thirdweb (esm) 62.57 KB (0%) 1.3 s (0%) 307 ms (+273.78% 🔺) 1.6 s
thirdweb (cjs) 345.55 KB (0%) 7 s (0%) 680 ms (+13.24% 🔺) 7.6 s
thirdweb (minimal + tree-shaking) 5.7 KB (0%) 114 ms (0%) 76 ms (+1311.03% 🔺) 190 ms
thirdweb/chains (tree-shaking) 531 B (0%) 11 ms (0%) 19 ms (+611.84% 🔺) 30 ms
thirdweb/react (minimal + tree-shaking) 19.56 KB (0%) 392 ms (0%) 70 ms (+484.83% 🔺) 461 ms

@catalyst17 catalyst17 force-pushed the docs_update_webhook_parameter_filtering_types_and_add_example branch from 299e713 to 766e444 Compare June 6, 2025 13:58
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 6, 2025 13:58 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 6, 2025 13:58 Inactive
@vercel vercel bot temporarily deployed to Preview – login June 6, 2025 13:58 Inactive
@github-actions github-actions bot added the Dashboard Involves changes to the Dashboard. label Jun 6, 2025
@catalyst17 catalyst17 force-pushed the docs_update_webhook_parameter_filtering_types_and_add_example branch from 766e444 to 0e3392b Compare June 6, 2025 14:02
@catalyst17 catalyst17 force-pushed the fix_make_contract_and_to_addresses_optional_in_webhook_form branch from ebd415e to da9ceef Compare June 6, 2025 14:02
@vercel vercel bot temporarily deployed to Preview – thirdweb-www June 6, 2025 14:02 Inactive
@vercel vercel bot temporarily deployed to Preview – login June 6, 2025 14:02 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 6, 2025 14:02 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 6, 2025 14:02 Inactive
@catalyst17 catalyst17 force-pushed the docs_update_webhook_parameter_filtering_types_and_add_example branch from 0e3392b to b6e40de Compare June 6, 2025 14:05
@catalyst17 catalyst17 force-pushed the fix_make_contract_and_to_addresses_optional_in_webhook_form branch from da9ceef to 340a10b Compare June 6, 2025 14:05
@vercel vercel bot temporarily deployed to Preview – thirdweb-www June 6, 2025 14:05 Inactive
@vercel vercel bot temporarily deployed to Preview – login June 6, 2025 14:05 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 6, 2025 14:05 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 6, 2025 14:05 Inactive
@catalyst17 catalyst17 force-pushed the docs_update_webhook_parameter_filtering_types_and_add_example branch from b6e40de to 8fe01c7 Compare June 6, 2025 14:30
@catalyst17 catalyst17 force-pushed the fix_make_contract_and_to_addresses_optional_in_webhook_form branch from 340a10b to a176c4d Compare June 6, 2025 14:30
@vercel vercel bot temporarily deployed to Preview – login June 6, 2025 14:30 Inactive
@vercel vercel bot temporarily deployed to Preview – wallet-ui June 6, 2025 14:30 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb_playground June 6, 2025 14:30 Inactive
@vercel vercel bot temporarily deployed to Preview – thirdweb-www June 6, 2025 14:30 Inactive
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dashboard Involves changes to the Dashboard. Portal Involves changes to the Portal (docs) codebase.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants