curl --request POST \
--url https://sandbox-api.polygon.technology/v0.11/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"url": "https://partner.example/webhooks",
"subscriptions": [
"transaction.settled",
"*"
],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
'import requests
url = "https://sandbox-api.polygon.technology/v0.11/webhooks"
payload = {
"url": "https://partner.example/webhooks",
"subscriptions": ["transaction.settled", "*"],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: 'https://partner.example/webhooks',
subscriptions: ['transaction.settled', '*'],
timeoutMs: 123,
notifyThresholdSecs: 123
})
};
fetch('https://sandbox-api.polygon.technology/v0.11/webhooks', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example/webhooks',
'subscriptions' => [
'transaction.settled',
'*'
],
'timeoutMs' => 123,
'notifyThresholdSecs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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"
payload := strings.NewReader("{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://sandbox-api.polygon.technology/v0.11/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.11/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}"
response = http.request(request)
puts response.read_body{
"webhook": {
"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"
},
"signingKey": "<string>"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}{
"error": "Unauthorized",
"code": 1000,
"msg": "unauthorized access",
"status": 401,
"cause": "signature"
}Create a webhook
Registers an HTTPS endpoint with event subscriptions. The HMAC signing key is returned in cleartext once and never again.
curl --request POST \
--url https://sandbox-api.polygon.technology/v0.11/webhooks \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--data '
{
"url": "https://partner.example/webhooks",
"subscriptions": [
"transaction.settled",
"*"
],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
'import requests
url = "https://sandbox-api.polygon.technology/v0.11/webhooks"
payload = {
"url": "https://partner.example/webhooks",
"subscriptions": ["transaction.settled", "*"],
"timeoutMs": 123,
"notifyThresholdSecs": 123
}
headers = {
"Idempotency-Key": "<idempotency-key>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
url: 'https://partner.example/webhooks',
subscriptions: ['transaction.settled', '*'],
timeoutMs: 123,
notifyThresholdSecs: 123
})
};
fetch('https://sandbox-api.polygon.technology/v0.11/webhooks', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://partner.example/webhooks',
'subscriptions' => [
'transaction.settled',
'*'
],
'timeoutMs' => 123,
'notifyThresholdSecs' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>"
],
]);
$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"
payload := strings.NewReader("{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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.post("https://sandbox-api.polygon.technology/v0.11/webhooks")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox-api.polygon.technology/v0.11/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://partner.example/webhooks\",\n \"subscriptions\": [\n \"transaction.settled\",\n \"*\"\n ],\n \"timeoutMs\": 123,\n \"notifyThresholdSecs\": 123\n}"
response = http.request(request)
puts response.read_body{
"webhook": {
"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"
},
"signingKey": "<string>"
}{
"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
Headers
Unique key to prevent duplicate requests. Required on all POST requests.
Body
"https://partner.example/webhooks"
["transaction.settled", "*"]
Per-webhook HTTP timeout in milliseconds. Default 5000, hard cap 10000.
Down-notification threshold in seconds (600 – 86400; default 3600).
Response
Webhook created
A partner-configured webhook endpoint. The signing key is never serialized back; it is returned in cleartext only from create/rotate-key.
Hide child attributes
Hide child attributes
"whk_01H9Xa8F5dN6mP3q"
"webhook"
"https://partner.example/webhooks"
Webhook lifecycle state. suspended is set only by the service when the endpoint is unhealthy.
enabled, disabled, suspended Set on transition to suspended; describes the down/suspend cause.
["transaction.settled", "*"]
Per-webhook HTTP timeout. Default 5000, hard cap 10000.
5000
Down-notification threshold (10 min – 1 day; default 1 h).
live, sandbox Cleartext HMAC signing key. Shown once — store it immediately; it is never returned again.
Was this page helpful?