docs: add webhooks section to agents and LLMs documentation #7317
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
WalkthroughNew documentation sections about webhooks were added to describe their use with the Insight API for real-time blockchain event notifications. The webhook filtering documentation was expanded to clarify support for multiple ABIs, including examples for handling events with shared signature hashes. No changes were made to code, APIs, or exported entities. Changes
Sequence Diagram(s)sequenceDiagram
User->>Insight API: Create webhook with filter (multiple ABIs)
Insight API->>Blockchain: Monitor for matching events/transactions
Blockchain-->>Insight API: Emits event (e.g., Transfer)
Insight API->>Insight API: Decode event using provided ABI(s)
Insight API->>Webhook Endpoint: Send payload with event/transaction data
Webhook Endpoint->>User Agent: Parse and process payload
Warning Review ran into problems🔥 ProblemsErrors were encountered while retrieving linked issues. Errors (2)
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (3)
🚧 Files skipped from review as they are similar to previous changes (3)
⏰ Context from checks skipped due to timeout of 90000ms (7)
🪧 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 (
|
github-actions
bot
added
the
Portal
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. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #7317 +/- ##
=======================================
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:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (3)
apps/portal/src/app/insight/agents-and-llms/page.mdx (1)
345-383: Use JSON code fences for JSON snippets
The webhook filter example is pure JSON, not TypeScript. Please change the fence fromtypescript tojson for clarity and correct syntax highlighting.- ```typescript + ```json { "v1.events": { "chain_ids": ["1"], "signatures": [ { "sig_hash": "0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef", "abi": "[{\"anonymous\":false,...},{\"anonymous\":false,...}]" } ] } } - ``` + ```apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx (1)
322-361: Standardize headings & use JSON fences
- The headings
### Filteringand### Payloadhere differ fromFiltering EventsandUnderstanding the Payloadin the main Agents & LLMs page. Align them for consistency across docs.- The webhook filter example is JSON; update the fence declaration accordingly.
- ### Filtering + ### Filtering Events - ### Payload + ### Understanding the Payload - ```typescript + ```json { "v1.events": { "chain_ids": ["1"], "signatures": [ { ... } ] } } - ``` + ```apps/portal/src/app/insight/webhooks/filtering/page.mdx (1)
85-111: Use JSON fences for the multi-ABI example
The example payload is JSON, so switch the code block from TypeScript to JSON to ensure correct syntax highlighting.- ```typescript + ```json { ... "filters": { "v1.events": { "chain_ids": ["1"], "signatures": [ { "sig_hash": "...", "abi": "[{...},{...}]" } ] } } ... } - ``` + ```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (3)
apps/portal/src/app/insight/agents-and-llms/llmstxt/page.mdx(1 hunks)apps/portal/src/app/insight/agents-and-llms/page.mdx(1 hunks)apps/portal/src/app/insight/webhooks/filtering/page.mdx(3 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Size
- GitHub Check: Analyze (javascript)
🔇 Additional comments (1)
apps/portal/src/app/insight/webhooks/filtering/page.mdx (1)
31-38: Clarified optionalabiproperty
Great addition ofabi?: stringwith clear docs that it can accept a single object or an array of objects as a string. This accurately reflects the new multi-ABI support.
size-limit report 📦
|
Merge activity
|
# [Portal] Feature: Add Webhooks Documentation for AI Agents + Example with multiple ABIs for decoding ## Notes for the reviewer Example with multiple ABIs for decoding ([related PR](https://app.graphite.dev/github/pr/thirdweb-dev/insight-service/268/fix-improve-ABI-validation-to-support-array-format)) 1. Added examples on creating events filters with multiple ABI options Also, this PR adds comprehensive documentation about using webhooks with AI agents in the Insight platform. The documentation covers: 1. Use cases for webhooks with AI agents 2. How to create and manage webhooks 3. Filtering capabilities, including support for multiple ABIs 4. Information about webhook payloads <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Added a new "Webhooks" section describing how to use webhooks with the Insight API for real-time blockchain event notifications and event-driven AI agents. - Provided use cases, filter examples, and links to detailed webhook and payload documentation. - Enhanced webhook filter documentation to clarify support for multiple ABIs, including examples for handling ERC-20 and ERC-721 Transfer events. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
graphite-app
bot
force-pushed
the
arsenii/infra-1447-allow-filtering-by-multiple-abi-options
branch
from
a332124 to
6393560
Compare
graphite-app
bot
deleted the
arsenii/infra-1447-allow-filtering-by-multiple-abi-options
branch
[Portal] Feature: Add Webhooks Documentation for AI Agents + Example with multiple ABIs for decoding
Notes for the reviewer
Example with multiple ABIs for decoding (related PR)
Also, this PR adds comprehensive documentation about using webhooks with AI agents in the Insight platform. The documentation covers:
Summary by CodeRabbit
PR-Codex overview
This PR enhances the documentation for
Webhooks, detailing their functionality, use cases, and configuration. It introduces clearer explanations and examples for creating and managing webhooks, filtering events, and understanding payloads, aimed at aiding developers in building event-driven AI agents.Detailed summary
Webhookswith an overview and use cases.Insight API.ERC-20andERC-721.