Update a Webhook Subscription

Partial update: any of url, events, metadata. Absent fields are left unchanged; a body carrying none of the three is rejected with 400 missing_required_field.

url — validated with the same HTTPS/SSRF rules as creation.
events — must be non-empty when present; every entry must be a known event type or the "*" wildcard (unknown types fail with 422, keyed by position).
metadata — replaces the whole map ({} clears it); no per-key merge.

status and the signing secret are not patchable — unknown fields are rejected with 400 unknown_field. Use POST /v1/webhooks/{id}/deactivate and POST /v1/webhooks/{id}/secret/rotate instead.

Requires an Idempotency-Key header.

PATCH

webhooks

{id}

Update a webhook subscription

curl --request PATCH \
  --url https://api.antonpayments.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "metadata": {}
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', events: [], metadata: {}})
};

fetch('https://api.antonpayments.com/v1/webhooks/{id}', 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.antonpayments.com/v1/webhooks/{id}",
  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>',
    'events' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "DPoP: <api-key>",
    "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://api.antonpayments.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<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))

}

{
  "data": {
    "id": "whk_01HX8Z9K0M2N3P4Q5R6S7T8UW",
    "merchant_id": "<string>",
    "url": "<string>",
    "events": [
      "payout.created"
    ],
    "status": "active",
    "version": "2024-01-01",
    "created_at": "2026-04-15T14:30:00Z",
    "updated_at": "2026-04-15T14:30:00Z",
    "metadata": {}
  }
}

Authorizations

DPoP

string

header

required

Per-request DPoP proof JWT (RFC 9449). MUST accompany the Authorization: DPoP <access_token> header on every protected operation. The proof is signed by the merchant's private DPoP key and carries htm, htu, iat, jti, and ath claims.

Headers

Idempotency-Key

string

required

Unique key identifying this operation. Sending the same key twice returns the original response instead of creating a duplicate. Keys are retained for 24 hours.

Maximum string length: 255

Path Parameters

string

required

Pattern: ^whk_[a-zA-Z0-9]+$

Body

application/json

Partial update for PATCH /v1/webhooks/{id}. Include at least one field. metadata replaces the entire map. Status changes and secret rotation go through their dedicated endpoints.

url

string<uri>

New HTTPS delivery URL. Same validation rules as creation.

events

enum<string>[]

Full replacement event filter. Must be non-empty when present.

See Webhook Events for the full catalog and payload shapes. Some reserved event types (balance.low on some paths) may be defined but not yet dispatched — subscribing to them is safe but no deliveries arrive until they're wired up.

Available options:

payout.created,

payout.approved,

payout.processing,

payout.sent,

payout.completed,

payout.failed,

payout.cancelled,

payout.returned,

payout.screening_failed,

payout.velocity_blocked,

payout.engine_blocked,

beneficiary.created,

beneficiary.updated,

beneficiary.deleted,

beneficiary.blocked,

instrument.created,

instrument.updated,

instrument.deleted,

batch.uploaded,

batch.completed,

batch.failed,

fx.quote.created,

fx.exchange.created,

fx.exchange.completed,

fx.exchange.failed,

funding.credit,

screening.hit,

intelligence.evaluation.completed,

intelligence.evaluation.failed,

balance.low,

test

metadata

object

Show child attributes

Response

The updated subscription (same shape as GET; the secret is never included).

data

object

required

A registered webhook endpoint and its event filter.

Show child attributes

⌘I

Update a webhook subscription

curl --request PATCH \
  --url https://api.antonpayments.com/v1/webhooks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'DPoP: <api-key>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "url": "<string>",
  "events": [],
  "metadata": {}
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    DPoP: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({url: '<string>', events: [], metadata: {}})
};

fetch('https://api.antonpayments.com/v1/webhooks/{id}', 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.antonpayments.com/v1/webhooks/{id}",
  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>',
    'events' => [
        
    ],
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "DPoP: <api-key>",
    "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://api.antonpayments.com/v1/webhooks/{id}"

	payload := strings.NewReader("{\n  \"url\": \"<string>\",\n  \"events\": [],\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("DPoP", "<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))

}

{
  "data": {
    "id": "whk_01HX8Z9K0M2N3P4Q5R6S7T8UW",
    "merchant_id": "<string>",
    "url": "<string>",
    "events": [
      "payout.created"
    ],
    "status": "active",
    "version": "2024-01-01",
    "created_at": "2026-04-15T14:30:00Z",
    "updated_at": "2026-04-15T14:30:00Z",
    "metadata": {}
  }
}

Overview

Cross-Cutting

Reference Data

Beneficiaries

Instruments

Intelligence

Verifications

Payouts

Batches

Balances

Accounts

Webhooks

Pricing

FX

Corridors

Update a Webhook Subscription

Authorizations

Headers

Path Parameters

Body

Response