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

The filter_function parameter can only be updated for existing webhooks that were created with custom filters. New webhooks created from templates cannot use custom filters. For advanced filtering capabilities, consider using Streams.

Path Parameters

id

string

REQUIRED

Loading...

Body Parameters

name

string

Loading...

filter_function

string

Loading...

notification_email

string

Loading...

destination_attributes

object

Loading...

url

string

Loading...

security_token

string

Loading...

compression

string

Loading...

nonegzip

Returns

id

string

Loading...

created_at

string

Loading...

name

string

Loading...

network

string

Loading...

notification_email

string

Loading...

destination_attributes

object

Loading...

url

string

Loading...

security_token

string

Loading...

compression

string

Loading...

sequence

integer

Loading...

status

string

Loading...

templateId

string

Loading...

templateArgs

object

Loading...

Request

1
curl -X PATCH \
2
    "https://api.quicknode.com/webhooks/rest/v1/webhooks/YOUR_WEBHOOK_ID" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "name": "Updated Webhook Name",
8
  "filter_function": "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
9
  "notification_email": "updated@example.com",
10
  "destination_attributes": {
11
    "url": "https://webhook.site/your-updated-url",
12
    "security_token": "updated-security-token",
13
    "compression": "gzip"
14
  },
15
  "status": "active"
16
}' 

1
curl -X PATCH \
2
    "https://api.quicknode.com/webhooks/rest/v1/webhooks/YOUR_WEBHOOK_ID" \
3
    -H "accept: application/json" \
4
    -H "Content-Type: application/json" \
5
    -H "x-api-key: YOUR_API_KEY" \
6
    -d $'{
7
  "name": "Updated Webhook Name",
8
  "filter_function": "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
9
  "notification_email": "updated@example.com",
10
  "destination_attributes": {
11
    "url": "https://webhook.site/your-updated-url",
12
    "security_token": "updated-security-token",
13
    "compression": "gzip"
14
  },
15
  "status": "active"
16
}' 

1
const axios = require('axios')
2

3
const webhookId = 'YOUR_WEBHOOK_ID' // Replace with your actual webhook ID
4
const url = `https://api.quicknode.com/webhooks/rest/v1/webhooks/${webhookId}`
5

6
const payload = {
7
	name: 'Updated Webhook Name',
8
	filter_function:
9
		'dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K',
10
	notification_email: 'updated@example.com',
11
	destination_attributes: {
12
		url: 'https://webhook.site/your-updated-url',
13
		security_token: 'updated-security-token',
14
		compression: 'gzip',
15
	},
16
	status: 'active',
17
}
18

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

25
axios
26
	.patch(url, payload, { headers })
27
	.then(response => {
28
		console.log(response.data)
29
	})
30
	.catch(error => {
31
		console.error('Error:', error.response?.data || error.message)
32
	})
33

1
const axios = require('axios')
2

3
const webhookId = 'YOUR_WEBHOOK_ID' // Replace with your actual webhook ID
4
const url = `https://api.quicknode.com/webhooks/rest/v1/webhooks/${webhookId}`
5

6
const payload = {
7
	name: 'Updated Webhook Name',
8
	filter_function:
9
		'dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K',
10
	notification_email: 'updated@example.com',
11
	destination_attributes: {
12
		url: 'https://webhook.site/your-updated-url',
13
		security_token: 'updated-security-token',
14
		compression: 'gzip',
15
	},
16
	status: 'active',
17
}
18

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

25
axios
26
	.patch(url, payload, { headers })
27
	.then(response => {
28
		console.log(response.data)
29
	})
30
	.catch(error => {
31
		console.error('Error:', error.response?.data || error.message)
32
	})
33

1
import requests
2

3
webhook_id = "YOUR_WEBHOOK_ID"  # Replace with your actual webhook ID
4
url = f"https://api.quicknode.com/webhooks/rest/v1/webhooks/{webhook_id}"
5

6
payload = {
7
    "name": "Updated Webhook Name",
8
    "filter_function": "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
9
    "notification_email": "updated@example.com",
10
    "destination_attributes": {
11
        "url": "https://webhook.site/your-updated-url",
12
        "security_token": "updated-security-token",
13
        "compression": "gzip"
14
    },
15
    "status": "active"
16
}
17

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

24
response = requests.patch(url, headers=headers, json=payload)
25

26
print(response.text) 

1
import requests
2

3
webhook_id = "YOUR_WEBHOOK_ID"  # Replace with your actual webhook ID
4
url = f"https://api.quicknode.com/webhooks/rest/v1/webhooks/{webhook_id}"
5

6
payload = {
7
    "name": "Updated Webhook Name",
8
    "filter_function": "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
9
    "notification_email": "updated@example.com",
10
    "destination_attributes": {
11
        "url": "https://webhook.site/your-updated-url",
12
        "security_token": "updated-security-token",
13
        "compression": "gzip"
14
    },
15
    "status": "active"
16
}
17

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

24
response = requests.patch(url, headers=headers, json=payload)
25

26
print(response.text) 

1
require "uri"
2
require "net/http"
3
require "json"
4

5
webhook_id = "YOUR_WEBHOOK_ID"  # Replace with your actual webhook ID
6
url = URI("https://api.quicknode.com/webhooks/rest/v1/webhooks/#{webhook_id}")
7

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

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

16
request.body = {
17
  "name" => "Updated Webhook Name",
18
  "filter_function" => "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
19
  "notification_email" => "updated@example.com",
20
  "destination_attributes" => {
21
    "url" => "https://webhook.site/your-updated-url",
22
    "security_token" => "updated-security-token",
23
    "compression" => "gzip"
24
  },
25
  "status" => "active"
26
}.to_json
27

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

1
require "uri"
2
require "net/http"
3
require "json"
4

5
webhook_id = "YOUR_WEBHOOK_ID"  # Replace with your actual webhook ID
6
url = URI("https://api.quicknode.com/webhooks/rest/v1/webhooks/#{webhook_id}")
7

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

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

16
request.body = {
17
  "name" => "Updated Webhook Name",
18
  "filter_function" => "dHJ5IHsKICAgIHZhciBkYXRhID0gSlNPTi5wYXJzZShzdHJlYW1EYXRhKTsKICAgIC8vIENvbnZlcnQgaGV4IG51bWJlciB0byBkZWNpbWFsCiAgICB2YXIgbnVtYmVyRGVjaW1hbCA9IHBhcnNlSW50KGRhdGEubnVtYmVyLCAxNik7CiAgICB2YXIgZmlsdGVyZWREYXRhID0ge2hhc2g6IGRhdGEuaGFzaCwgbnVtYmVyOiBudW1iZXJEZWNpbWFsfTsKICAgIEpTT04uc3RyaW5naWZ5KGZpbHRlcmVkRGF0YSk7Cn0gY2F0Y2ggKGUpIHsKICAgIEpTT04uc3RyaW5naWZ5KHtlcnJvcjogZS5tZXNzYWdlfSk7Cn0K",
19
  "notification_email" => "updated@example.com",
20
  "destination_attributes" => {
21
    "url" => "https://webhook.site/your-updated-url",
22
    "security_token" => "updated-security-token",
23
    "compression" => "gzip"
24
  },
25
  "status" => "active"
26
}.to_json
27

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

1
qn webhook update {webhook_id} --url https://example.com/hook2 \
2
      --notification-email alice@example.com \
3
      -o json

1
qn webhook update {webhook_id} --url https://example.com/hook2 \
2
      --notification-email alice@example.com \
3
      -o json

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.webhooks.updateWebhook("WEBHOOK_ID", { name: "Updated webhook" })
6
console.log(response)
7

1
import { QuicknodeSdk } from "@quicknode/sdk"
2

3
const qn = new QuicknodeSdk({ apiKey: "YOUR_API_KEY" })
4

5
const response = await qn.webhooks.updateWebhook("WEBHOOK_ID", { name: "Updated webhook" })
6
console.log(response)
7

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.webhooks.update_webhook("WEBHOOK_ID", name="Updated webhook")
8
    print(response)
9

10

11
asyncio.run(main())
12

1
import asyncio
2
from quicknode_sdk import QuicknodeSdk, SdkFullConfig
3

4

5
async def main():
6
    qn = QuicknodeSdk(SdkFullConfig(api_key="YOUR_API_KEY"))
7
    response = await qn.webhooks.update_webhook("WEBHOOK_ID", name="Updated webhook")
8
    print(response)
9

10

11
asyncio.run(main())
12

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.webhooks.update_webhook("WEBHOOK_ID", name: "Updated webhook")
6
puts response
7

1
require "quicknode_sdk"
2

3
qn = QuicknodeSdk::SDK.from_config(api_key: "YOUR_API_KEY")
4

5
response = qn.webhooks.update_webhook("WEBHOOK_ID", name: "Updated webhook")
6
puts response
7

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.webhooks.update_webhook("WEBHOOK_ID", &quicknode_sdk::webhooks::UpdateWebhookParams { name: Some("Updated webhook".to_string()), ..Default::default() }).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

1
use quicknode_sdk::{QuicknodeSdk, SdkFullConfig};
2

3
#[tokio::main]
4
async fn main() -> Result<(), Box<dyn std::error::Error>> {
5
    let qn = QuicknodeSdk::new(&SdkFullConfig::builder().api_key("YOUR_API_KEY").build())?;
6
    let response = qn.webhooks.update_webhook("WEBHOOK_ID", &quicknode_sdk::webhooks::UpdateWebhookParams { name: Some("Updated webhook".to_string()), ..Default::default() }).await?;
7

8
    println!("{:?}", response);
9
    Ok(())
10
}
11

Try in Swagger

Don't have an account yet?

Create your Quicknode endpoint in seconds and start building

Get started for free