Update a webhook
Partial update — include only the fields you want to change.
Common operations:
- Change URL:
{ "url": "https://new-server.com/webhooks" } - Change subscribed events:
{ "events": ["*"] } - Disable (stop receiving events):
{ "isActive": false } - Re-enable:
{ "isActive": true }— this also resets the failure count to 0
Automatic catch-up on re-enable: while an endpoint is disabled (manually or
suspended after 24 hours of failed deliveries), no deliveries are attempted or
recorded for it. When you re-enable it, the events it missed during the
disabled window are automatically re-dispatched to it, oldest first (up to 500
events, looking back at most 7 days), and deliveries that failed terminally in
the 26 hours before the disable are retried. fill.created and
account.balance_changed are not included in catch-up — recover missed
fills and balance changes via the event stream’s ?since= replay or
GET /platform/v1/organization/snapshots/fills; snapshot.ready is not
replayed either. Catch-up
deliveries are normal deliveries: same payloads (account state is rendered at
send time), same signatures, and the original event id and createdAt —
dedupe as usual.
Note: To change the signing secret, use the dedicated rotate-secret endpoint instead.
Authentication: send your organization API key in the X-API-Key header.
Access: full-access API keys only (a read-only key gets 403 READ_ONLY_KEY). Dashboard members need manage access to Webhooks.
curl --request PUT \
--url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://new-server.com/webhooks",
"events": [
"*"
],
"description": "Updated production webhook",
"isActive": false
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}"
payload = {
"url": "https://new-server.com/webhooks",
"events": ["*"],
"description": "Updated production webhook",
"isActive": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://new-server.com/webhooks',
events: ['*'],
description: 'Updated production webhook',
isActive: false
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/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://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://new-server.com/webhooks',
'events' => [
'*'
],
'description' => 'Updated production webhook',
'isActive' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.put("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab",
"url": "https://your-server.com/webhooks/hyperprop",
"events": [
"account.created",
"account.status_changed"
],
"description": "Production webhook",
"isActive": true,
"failureCount": 0,
"disabledAt": "2026-03-28T22:00:00.000Z",
"disabledReason": "Suspended automatically: every delivery failed for 24 hours (412 failed attempts since 2026-03-27 21:58 UTC). Turn it back on to resume deliveries.",
"lastTriggeredAt": "2026-03-28T21:30:00.000Z",
"createdAt": "2026-03-28T21:00:00.000Z",
"updatedAt": "2026-03-28T21:30:00.000Z"
},
"message": "Webhook updated successfully"
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Validation failed",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Webhook not found",
"code": "NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}Authorizations
Organization API key (hp_live_...), sent in the X-API-Key header. Create, rotate and restrict keys in the dashboard or with the API keys endpoints; an organization can have two active keys, so you can rotate without downtime. A full-access key can call every endpoint in this reference. A read-only key can call GET endpoints (and create a trading stream token); any other request returns 403 READ_ONLY_KEY. A key with an IP allowlist returns 403 IP_NOT_ALLOWED from any other address. Each endpoint lists which keys can call it under Access.
Headers
Optional. A value that identifies this operation on your side, at most 255 characters. A retry with the same key, method, path and body within 24 hours returns the original response (with Idempotency-Replayed: true) instead of repeating the change. The same key with a different body returns 409 IDEMPOTENCY_KEY_REUSED; a retry while the first request is still running returns 409 IDEMPOTENCY_KEY_IN_PROGRESS. A response that contains a credential (such as a new API key or signing secret) is not saved: the change is still not repeated, and a retry returns 409 IDEMPOTENCY_KEY_COMPLETED with the original status in originalStatus. Server errors (5xx) are not saved, so a retry runs again. If the key cannot be recorded, the request is not run and returns 503 IDEMPOTENCY_UNAVAILABLE; retry with the same key.
255Body
Updated event subscriptions
1*, account.created, account.status_changed, account.updated, account.imported, account.unlinked, account.passed, account.failed, account.lockout_created, account.lockout_removed, account.lockout_updated, account.payout_processed, account.max_payouts_reached, account.payout_reversed, account.time_limit_extended, account.daily_loss_limit_off, account.daily_loss_limit_on, account.claim_refused, purchase.created, purchase.status_changed, trader.created, snapshot.ready, fill.created, account.balance_changed, account.balance_adjusted, account.trading_day_reverted, account.trading_day_revert_undone, risk.report_ready, risk.hedge_pair_flagged, risk.copy_trading_flagged, risk.shared_device_flagged, trader.signed_in, alert.limit_crossed, alert.limit_cleared ["*"]
curl --request PUT \
--url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"url": "https://new-server.com/webhooks",
"events": [
"*"
],
"description": "Updated production webhook",
"isActive": false
}
'import requests
url = "https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}"
payload = {
"url": "https://new-server.com/webhooks",
"events": ["*"],
"description": "Updated production webhook",
"isActive": False
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
url: 'https://new-server.com/webhooks',
events: ['*'],
description: 'Updated production webhook',
isActive: false
})
};
fetch('https://api.hyperprop.com/platform/v1/organization/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://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'url' => 'https://new-server.com/webhooks',
'events' => [
'*'
],
'description' => 'Updated production webhook',
'isActive' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-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://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}"
payload := strings.NewReader("{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.put("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"url\": \"https://new-server.com/webhooks\",\n \"events\": [\n \"*\"\n ],\n \"description\": \"Updated production webhook\",\n \"isActive\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"id": "d2f3a1c0-8e7b-4f6a-9c5d-1234567890ab",
"url": "https://your-server.com/webhooks/hyperprop",
"events": [
"account.created",
"account.status_changed"
],
"description": "Production webhook",
"isActive": true,
"failureCount": 0,
"disabledAt": "2026-03-28T22:00:00.000Z",
"disabledReason": "Suspended automatically: every delivery failed for 24 hours (412 failed attempts since 2026-03-27 21:58 UTC). Turn it back on to resume deliveries.",
"lastTriggeredAt": "2026-03-28T21:30:00.000Z",
"createdAt": "2026-03-28T21:00:00.000Z",
"updatedAt": "2026-03-28T21:30:00.000Z"
},
"message": "Webhook updated successfully"
}{
"success": false,
"statusCode": 400,
"error": "Bad Request",
"message": "Validation failed",
"code": "VALIDATION_ERROR"
}{
"success": false,
"statusCode": 401,
"error": "Unauthorized",
"message": "Authentication required",
"code": "UNAUTHORIZED"
}{
"success": false,
"statusCode": 403,
"error": "Forbidden",
"message": "Access denied",
"code": "FORBIDDEN"
}{
"success": false,
"statusCode": 404,
"error": "Not Found",
"message": "Webhook not found",
"code": "NOT_FOUND"
}{
"success": false,
"statusCode": 409,
"error": "Conflict",
"message": "This Idempotency-Key was already used with a different request body. Use a new key for a different request.",
"code": "IDEMPOTENCY_KEY_REUSED"
}{
"success": false,
"statusCode": 429,
"error": "Too Many Requests",
"message": "Too many requests to this endpoint. Try again in 12 second(s).",
"code": "RATE_LIMITED"
}{
"success": false,
"statusCode": 500,
"error": "Internal Server Error",
"message": "An unexpected error occurred",
"code": "INTERNAL_ERROR"
}{
"success": false,
"statusCode": 503,
"error": "Service Unavailable",
"message": "The Idempotency-Key could not be recorded, so the request was not run. Retry with the same key.",
"code": "IDEMPOTENCY_UNAVAILABLE"
}