跳至主要內容

Webhooks REST API

更新於
2026年7月1日

OpenAPI Specification​

View the complete OpenAPI specification for this REST API.

概覽​

The Webhooks REST API enables you to deploy and manage your Webhooks using a REST API interface.

Adding, updating, and managing your Webhooks is quick and easy!

存取​

To access the Webhooks REST API, you will first need to create an API key. Your API key should be set as an x-api-key header with your requests.

API Base URL: https://api.quicknode.com/

支援的網路​

The Webhooks REST API is available on these chains and networks:

鏈條主網測試網
0g✅伽利略測試網
摘要✅測試網
Arbitrum✅塞波利亞
Arbitrum Nova✅
Arc測試網
奧爾特✅測試網
Avalanche C-Chain✅Fuji
B3✅塞波利亞
基地✅塞波利亞
Bera✅Bepolia
比特幣✅測試網 4
比特幣現金✅測試網
爆炸✅塞波利亞
BNB Smart Chain✅測試網
Celo✅
網路✅塞波利亞
狗狗幣✅
以太坊✅Hoodi, Sepolia
Fantom✅
Flare✅測試網
流程✅測試網
流利測試網
Fraxtal✅
Gnosis✅
重力✅
常春藤✅測試網
Hemi✅測試網
Hyperliquid EVM✅測試網
Hyperliquid Hypercore✅
不可變 zkEVM✅測試網
單射✅測試網
墨水✅塞波利亞
日本開放鏈✅
凱亞✅測試網
Katana✅
鏡頭✅測試網
Linea✅
Lisk✅
萊特幣✅測試網
Mantle✅塞波利亞
MegaETH✅
莫卡測試網
模式✅
單子✅測試網
Morph✅Hoodi
樂觀✅塞波利亞
Peaq✅
等離子體✅測試網
Polygon✅Amoy
Polygon zkEVM✅卡多納測試網
Robinhood✅測試網
撒哈拉測試網
捲動✅測試網
Sei✅測試網
索拉納✅Devnet, Testnet
索尼厄姆✅
索尼克✅
索福尼✅
Stellar✅測試網
資料✅《埃涅阿斯紀》測試網
Tempo✅測試網
Tron✅
Unichain✅塞波利亞
瓦納✅Moksha Testnet
Worldchain✅塞波利亞
X 層✅測試網
Xai✅塞波利亞
XRP 帳本✅測試網
XRPL EVM✅測試網
zkSync✅塞波利亞
佐拉✅

API 端點​

The Webhooks REST API provides the following endpoints for managing your webhooks:

Creating Webhooks​

Webhooks are created using predefined templates that cover common use cases:

Advanced Filtering

If you need a filter that isn't covered by our templates, please contact support to request a new template. For advanced filtering capabilities with custom JavaScript functions, consider using Streams.

Available Templates​

  • evmWalletFilter: Monitor specific EVM wallet addresses
  • evmContractEvents: Monitor specific contract events
  • evmAbiFilter: Monitor contracts using ABI definitions
  • solanaWalletFilter: Monitor specific Solana account addresses
  • bitcoinWalletFilter: Monitor specific Bitcoin wallet addresses
  • xrplWalletFilter: Monitor specific XRP Ledger wallet addresses
  • hyperliquidWalletEventsFilter: Monitor specific Hyperliquid wallet addresses
  • stellarWalletTransactionsSourceAccountFilter: Monitor specific Stellar wallet addresses

How to use templates: When creating a webhook from a template, the templateArgs object contains the template-specific properties directly. The template type is specified in the URL path (/webhooks/template/{templateId}), and the templateArgs contains the actual configuration data for that template. You can provide either inline values (e.g. wallet addresses directly) or reference names of kv store lists.

範例: For the evmWalletFilter template, you would:

  • Use URL: /webhooks/template/evmWalletFilter
  • Include in body (inline): "templateArgs": { "wallets": ["0x1234..."] }
  • Or (list reference): "templateArgs": { "walletsListName": "my_wallets_list" }

Managing Webhooks​

Controlling Webhooks​

驗證​

All API requests require authentication using your Quicknode API key. Include your API key in the request headers:

x-api-key: YOUR_API_KEY

Error Handling​

The API returns standard HTTP status codes:

  • 200 OK: Request successful
  • 201 Created: Resource created successfully
  • 400 Bad Request: Invalid request parameters
  • 401 Unauthorized: Invalid or missing API key

Webhook Configuration​

When creating or updating webhooks, you can configure the following parameters:

  • Name: A descriptive name for your webhook
  • Network: The blockchain network to monitor
  • Notification Email: Email address for termination notifications
  • Destination Attributes: Object containing:
    • URL: The endpoint where data will be sent
    • Security Token: Token for webhook authentication
    • Compression: Optional gzip compression for payloads
  • Status: Whether the webhook is active or paused
  • Template Args: Template-specific arguments (for template-based webhooks)

Template-Based Webhooks​

Template-based webhooks provide a simplified way to create common webhook configurations:

evmWalletFilter​

Monitor specific EVM wallet addresses:

{
  "templateArgs": {
    "wallets": ["0x1234...", "0x5678..."]
  }
}

evmContractEvents​

Monitor specific contract events (both fields are optional, but at least one should be provided):

{
  "templateArgs": {
    "contracts": ["0x1234..."],
    "eventHashes": ["0xddf252ad1be2c89b69c2b068fc378daa952ba7f163c4a11628f55a4df523b3ef"]
  }
}

solanaWalletFilter​

Monitor specific Solana accounts:

{
  "templateArgs": {
    "accounts": ["9WzDXwBbmkg8ZTbNMqUxvQRAyrZzDsGYdLVL9zYtAWWM"]
  }
}

bitcoinWalletFilter​

Monitor specific Bitcoin wallet addresses:

{
  "templateArgs": {
    "wallets": ["bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh"]
  }
}

evmAbiFilter​

Monitor contracts using ABI definitions (abi is required, contracts is optional):

{
  "templateArgs": {
    "abi": "[{\"anonymous\":false,\"inputs\":[{\"indexed\":true,\"name\":\"from\",\"type\":\"address\"}]}]",
    "contracts": ["0x1234..."]
  }
}

xrplWalletFilter​

Monitor specific XRP Ledger wallet addresses:

{
  "templateArgs": {
    "wallets": ["rN7n3473SaZBCG4dFL83w7p1W9cgZw6]"]
  }
}

hyperliquidWalletEventsFilter​

Monitor specific Hyperliquid wallet addresses:

{
  "templateArgs": {
    "wallets": ["0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"]
  }
}

stellarWalletTransactionsSourceAccountFilter​

Monitor specific Stellar wallet addresses:

{
  "templateArgs": {
    "wallets": ["GDQP2KPQGKIHYJGXNUIYOMHARUARCA7DJT5FO2FFOOUJ3B2BNQKFIGS"]
  }
}

Using List References​

Instead of providing inline values, you can reference kv store lists. This is useful for managing large sets of addresses:

{
  "templateArgs": {
    "walletsListName": "my_wallets_list"
  }
}

For contract events with kv store lists:

{
  "templateArgs": {
    "contractsListName": "my_contracts_list",
    "eventHashesListName": "my_event_hashes_list"
  }
}

Advanced Filtering​

For advanced filtering capabilities with custom JavaScript functions, consider using Streams, which provides full support for custom filter functions. Streams allows you to write JavaScript-based filtering logic to process and filter blockchain data before delivery.

For more information about filter functions in Streams, see the Filters documentation.

Webhook Delivery​

When a webhook is triggered, Quicknode sends a POST request to your specified URL with the filtered blockchain data. The payload includes:

  • data: The filtered blockchain events
  • metadata: Information about the webhook and delivery

安全​

The recommended way to secure your Webhook's destination endpoint is by implementing HMAC verification. This cryptographic method ensures that the incoming messages are coming from Webhooks and haven't been tampered with. For detailed information on implementing HMAC verification, see our guide on Validating Incoming Streams Webhook Messages.

IP Allowlisting (Additional Security)​

As an additional security measure, you can restrict access to your destination endpoint to specific IP addresses. Webhooks delivers data from the following IP address:

141.148.40.227

By adding this IP to your allowlist, you can add an extra layer of security to ensure that only legitimate Webhooks traffic is accepted by your webhook server.

Getting Help​

If you need assistance with the Webhooks REST API:

最後更新時間 於
分享這份文件