Organization

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 auto-disabled after consecutive failures), 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 any deliveries that failed terminally just before the disable are retried. fill.created is not included in catch-up — recover missed fills via the event stream’s ?since= replay or GET /platform/v1/organization/snapshots/fills. 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: Accepts either Authorization: Bearer <jwt> (dashboard) or X-API-Key: hp_live_... (programmatic).

PUT

organization

webhooks

{webhookId}

Update a webhook

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --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 = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<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 => [
    "Authorization: <api-key>",
    "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://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("Authorization", "<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("Authorization", "<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["Authorization"] = '<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": "Auto-disabled after 25 consecutive delivery failures",
    "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": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Authorizations

Authorization

string

header

required

JWT Bearer token for user session auth. Format: "Bearer {token}". Used by User and Organization endpoints.

Path Parameters

webhookId

string

required

Webhook ID

Body

application/json

url

string

New endpoint URL (HTTPS required)

Example:

"https://new-server.com/webhooks"

events

enum<string>[]

Updated event subscriptions

Minimum array length: 1

Available options:

*,

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,

purchase.created,

purchase.status_changed,

trader.created,

snapshot.ready,

fill.created,

account.balance_changed

Example:

["*"]

description

string

Updated label

Maximum string length: 255

Example:

"Updated production webhook"

isActive

boolean

Set to false to pause delivery, true to resume (resets failure count)

Example:

false

Response

Webhook updated

success

boolean

Example:

true

data

object

Show child attributes

message

string

Example:

"Webhook updated successfully"

⌘I

Update a webhook

curl --request PUT \
  --url https://api.hyperprop.com/platform/v1/organization/webhooks/{webhookId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --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 = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<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 => [
    "Authorization: <api-key>",
    "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://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("Authorization", "<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("Authorization", "<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["Authorization"] = '<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": "Auto-disabled after 25 consecutive delivery failures",
    "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": 500,
  "error": "Internal Server Error",
  "message": "An unexpected error occurred",
  "code": "INTERNAL_ERROR"
}

Platform API

Trade API

Market Data API

Update a webhook

Authorizations

Path Parameters

Body

Response