/webhooks/rest/v1/webhooks/template/{id} REST API Endpoint

Path Parameters

templateId

string

REQUIRED

The template ID. ENUM: "evmWalletFilter", "evmContractEvents", "solanaWalletFilter", "bitcoinWalletFilter", "evmAbiFilter"

Body Parameters

name

string

REQUIRED

A name for your webhook.

network

string

REQUIRED

The network for this webhook. ENUM: "abstract-mainnet", "abstract-testnet", "arbitrum-mainnet", "arbitrum-sepolia", "avalanche-fuji", "avalanche-mainnet", "b3-mainnet", "b3-sepolia", "base-mainnet", "base-sepolia", "bera-mainnet", "bera-bepolia", "bitcoin-mainnet", "blast-mainnet", "blast-sepolia", "bnbchain-mainnet", "bnbchain-testnet", "celo-mainnet", "cyber-mainnet", "cyber-sepolia", "ethereum-holesky", "ethereum-hoodi", "ethereum-mainnet", "ethereum-sepolia", "fantom-mainnet", "flow-mainnet", "flow-testnet", "fuse-flash", "gnosis-mainnet", "gravity-alpham", "hedera-mainnet", "hedera-testnet", "hemi-mainnet", "hemi-testnet", "imx-mainnet", "imx-testnet", "injective-mainnet", "injective-testnet", "ink-mainnet", "ink-sepolia", "joc-mainnet", "kaia-mainnet", "kaia-testnet", "lens-mainnet", "lens-testnet", "linea-mainnet", "mantle-mainnet", "mantle-sepolia", "monad-testnet", "morph-holesky", "morph-mainnet", "nova-mainnet", "omni-mainnet", "omni-omega", "optimism-mainnet", "optimism-sepolia", "peaq-mainnet", "plasma-testnet", "polygon-amoy", "polygon-mainnet", "race-mainnet", "race-testnet", "sahara-testnet", "scroll-mainnet", "scroll-testnet", "sei-mainnet", "sei-testnet", "solana-devnet", "solana-mainnet", "solana-testnet", "soneium-mainnet", "sophon-mainnet", "sophon-testnet", "story-aeneid", "story-mainnet", "tron-mainnet", "unichain-mainnet", "unichain-sepolia", "vana-mainnet", "vana-moksha", "worldchain-mainnet", "worldchain-sepolia", "xai-mainnet", "xai-sepolia", "zerog-galileo", "zkevm-cardona", "zkevm-mainnet", "zksync-mainnet", "zksync-sepolia", "zora-mainnet"

notification_email

string

Notify when webhook is terminated.

destination_attributes

object

REQUIRED

Webhook destination configuration including URL, security token, and compression settings.

url

string

The URL where webhook data will be sent.

security_token

string

Security token for webhook authentication. If no value is included, we will generate a token for this Webhook.

compression

string

Compression type for webhook payloads. ENUM: "none", "gzip"

status

string

REQUIRED

The initial status of the webhook. ENUM: "active", "paused"

templateArgs

object

REQUIRED

Template-specific arguments. The structure depends on the template type specified in the URL path. Use these args for the evmWalletFilter template.

wallets

array

Array of wallet addresses to monitor.

templateArgs

object

REQUIRED

Template-specific arguments. The structure depends on the template type specified in the URL path. Use these args for the evmContractEvents template.

contacts

array

Array of contract addresses to monitor.

eventHashes

array

Array of event hashes to monitor.

templateArgs

object

REQUIRED

Template-specific arguments. The structure depends on the template type specified in the URL path. Use these args for the solanaWalletFilter template.

accounts

array

Array of Solana account addresses to monitor.

templateArgs

object

REQUIRED

Template-specific arguments. The structure depends on the template type specified in the URL path. Use these args for the bitcoinWalletFilter template.

addresses

array

Array of Bitcoin addresses to monitor.

templateArgs

object

REQUIRED

Template-specific arguments. The structure depends on the template type specified in the URL path. Use these args for the evmAbiFilter template.

abi

string

ABI definition as a JSON string.

contracts

array

Array of contract addresses to monitor.

Returns

id

string

The ID of the webhook.

created_at

string

The timestamp when the webhook was created.

updated_at

string

The timestamp when the webhook was updated.

name

string

The webhook name.

network

string

The network of the webhook.

filter_function

string

The base64 encoded filter for the webhook.

notification_email

string

Email for termination notifications.

destination_attributes

object

Webhook destination configuration.

status

string

The current status of the webhook.

Request

curl -X POST \
    "https://api.quicknode.com/webhooks/rest/v1/webhooks/template/evmWalletFilter" \
    -H "accept: application/json" \
    -H "Content-Type: application/json" \
    -H "x-api-key: YOUR_API_KEY" \
    -d $'{
  "name": "My Wallet Monitor Webhook",
  "network": "ethereum-mainnet",
  "notification_email": "contact@example.com",
  "destination_attributes": {
    "url": "https://webhook.site/your-unique-url",
    "compression": "none"
  },
  "status": "active",
  "templateArgs": {
    "wallets": [
      "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "0xdac17f958d2ee523a2206206994597c13d831ec7"
    ]
  }
}' 

const axios = require('axios')

const templateId = 'evmWalletFilter' // Can be: evmWalletFilter, evmContractEvents, solanaWalletFilter, bitcoinWalletFilter, evmAbiFilter
const url = `https://api.quicknode.com/webhooks/rest/v1/webhooks/template/${templateId}`

const payload = {
	name: 'My Wallet Monitor Webhook',
	network: 'ethereum-mainnet',
	notification_email: 'contact@example.com',
	destination_attributes: {
		url: 'https://webhook.site/your-unique-url',
		compression: 'gzip',
	},
	status: 'active',
	templateArgs: {
		wallets: [
			'0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',
			'0xdac17f958d2ee523a2206206994597c13d831ec7',
		],
	},
}

const headers = {
	accept: 'application/json',
	'Content-Type': 'application/json',
	'x-api-key': 'YOUR_API_KEY', // Replace with your actual API key
}

axios
	.post(url, payload, { headers })
	.then(response => {
		console.log(response.data)
	})
	.catch(error => {
		console.error('Error:', error.response?.data || error.message)
	})

import requests

template_id = "evmWalletFilter"  # Can be: evmWalletFilter, evmContractEvents, solanaWalletFilter, bitcoinWalletFilter, evmAbiFilter
url = f"https://api.quicknode.com/webhooks/rest/v1/webhooks/template/{template_id}"

payload = {
    "name": "My Wallet Monitor Webhook",
    "network": "ethereum-mainnet",
    "notification_email": "contact@example.com",
    "destination_attributes": {
        "url": "https://webhook.site/your-unique-url",
        "compression": "gzip"
    },
    "status": "active",
    "templateArgs": {
        "wallets": [
            "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
            "0xdac17f958d2ee523a2206206994597c13d831ec7"
        ]
    }
}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "x-api-key": "YOUR_API_KEY"  # Replace with your actual API key
}

response = requests.post(url, headers=headers, json=payload)

print(response.text) 

require "uri"
require "net/http"
require "json"

template_id = "evmWalletFilter"  # Can be: evmWalletFilter, evmContractEvents, solanaWalletFilter, bitcoinWalletFilter, evmAbiFilter
url = URI("https://api.quicknode.com/webhooks/rest/v1/webhooks/template/#{template_id}")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["Content-Type"] = "application/json"
request["x-api-key"] = "YOUR_API_KEY"  # Replace with your actual API key

request.body = {
  "name" => "My Wallet Monitor Webhook",
  "network" => "ethereum-mainnet",
  "notification_email" => "contact@example.com",
  "destination_attributes" => {
    "url" => "https://webhook.site/your-unique-url",
    "compression" => "gzip"
  },
  "status" => "active",
  "templateArgs" => {
    "wallets" => [
      "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
      "0xdac17f958d2ee523a2206206994597c13d831ec7"
    ]
  }
}.to_json

response = https.request(request)
puts response.body 

Don't have an account yet?

Create your QuickNode endpoint in seconds and start building

Get started for free