docs: update webhook parameter filtering types and add example #7295
+23
−2
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the You can disable this status message by setting the 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed 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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
How to use the Graphite Merge QueueAdd either label to this PR to merge it via the merge queue:
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
bot
added
the
Portal
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7295 +/- ##
=======================================
Coverage 55.57% 55.57%
=======================================
Files 909 909
Lines 58673 58673
Branches 4158 4158
=======================================
Hits 32607 32607
Misses 25959 25959
Partials 107 107
🚀 New features to boost your workflow:
|
size-limit report 📦
|
iuwqyir
approved these changes
Jun 6, 2025
catalyst17
force-pushed
the
docs_update_webhook_parameter_filtering_types_and_add_example
branch
from
299e713 to
766e444
Compare
catalyst17
force-pushed
the
docs_update_webhook_parameter_filtering_types_and_add_example
branch
from
766e444 to
0e3392b
Compare
catalyst17
force-pushed
the
fix_make_contract_and_to_addresses_optional_in_webhook_form
branch
from
ebd415e to
da9ceef
Compare
catalyst17
force-pushed
the
docs_update_webhook_parameter_filtering_types_and_add_example
branch
from
b6e40de to
8fe01c7
Compare
catalyst17
force-pushed
the
fix_make_contract_and_to_addresses_optional_in_webhook_form
branch
from
340a10b to
a176c4d
Compare
AmineAfia
approved these changes
Jun 6, 2025
jnsdls
approved these changes
Jun 6, 2025
Merge activity
|
# [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.
<!-- start pr-codex -->
---
## 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}`
<!-- end pr-codex -->
graphite-app
bot
force-pushed
the
fix_make_contract_and_to_addresses_optional_in_webhook_form
branch
from
a176c4d to
62a3cd8
Compare
graphite-app
bot
force-pushed
the
docs_update_webhook_parameter_filtering_types_and_add_example
branch
from
8fe01c7 to
2d15cd6
Compare
Base automatically changed from
fix_make_contract_and_to_addresses_optional_in_webhook_form
to
main
June 9, 2025 12:08
graphite-app
bot
deleted the
docs_update_webhook_parameter_filtering_types_and_add_example
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
[Portal] Fix: Update webhook parameter filtering documentation
Notes for the reviewer
This PR updates the webhook filtering documentation to:
paramsin both events and transactions filtersTransferevents with specific parametersHow 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 focuses on updating the
paramsproperty in the webhook filtering configuration to allow for more specific data types. It enhances the ability to filter decoded parameters by changing the type fromanytostring | number, ensuring stricter data handling.Detailed summary
params?: Record<string, any>toparams?: Record<string, string | number>in the filtering configuration.paramsproperty under thesignaturesobject to the same type.Transferevents, specifying thefromaddress.