Update a webhook
curl --request PATCH \
--url https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"subscriptions": [
"<string>"
],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
'import requests
url = "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}"
payload = {
"url": "<string>",
"subscriptions": ["<string>"],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
subscriptions: ['<string>'],
timeoutMs: 123,
notifyThresholdSecs: 123
})
};
fetch('https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'subscriptions' => [
'<string>'
],
'timeoutMs' => 123,
'notifyThresholdSecs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "whk_01H9Xa8F5dN6mP3q",
"object": "webhook",
"url": "https://partner.example/webhooks",
"statusReason": "<string>",
"subscriptions": [
"transaction.settled",
"*"
],
"timeoutMs": 5000,
"notifyThresholdSecs": 123,
"successCount": 123,
"failureCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}Webhooks
Update a webhook
Partial update of URL, subscriptions, timeout, and notify threshold. Lifecycle is managed via enable/disable.
PATCH
/
webhooks
/
{webhookId}
Update a webhook
curl --request PATCH \
--url https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"url": "<string>",
"subscriptions": [
"<string>"
],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
'import requests
url = "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}"
payload = {
"url": "<string>",
"subscriptions": ["<string>"],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: '<string>',
subscriptions: ['<string>'],
timeoutMs: 123,
notifyThresholdSecs: 123
})
};
fetch('https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'url' => '<string>',
'subscriptions' => [
'<string>'
],
'timeoutMs' => 123,
'notifyThresholdSecs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.11/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"<string>\",\n \"subscriptions\": [\n \"<string>\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "whk_01H9Xa8F5dN6mP3q",
"object": "webhook",
"url": "https://partner.example/webhooks",
"statusReason": "<string>",
"subscriptions": [
"transaction.settled",
"*"
],
"timeoutMs": 5000,
"notifyThresholdSecs": 123,
"successCount": 123,
"failureCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}Authorizations
Token from POST /auth/token
Path Parameters
Body
application/json
Response
Webhook updated
A partner-configured webhook endpoint. The signing key is never serialized back; it is returned in cleartext only from create/rotate-key.
Example:
"whk_01H9Xa8F5dN6mP3q"
Example:
"webhook"
Example:
"https://partner.example/webhooks"
Webhook lifecycle state. suspended is set only by the service when the endpoint is unhealthy.
Available options:
enabled, disabled, suspended Set on transition to suspended; describes the down/suspend cause.
Example:
["transaction.settled", "*"]
Per-webhook HTTP timeout. Default 5000, hard cap 10000.
Example:
5000
Down-notification threshold (10 min – 1 day; default 1 h).
Available options:
live, sandbox Was this page helpful?
⌘I