Тема
Изменить подписку
PATCH /webhooks/{webhookUuid}
operationId: updateWebhook
Непереданные поля сохраняются. status=disabled при неизменном URL позволяет отключить получателя даже с недоступным DNS. Включение и остальные изменения перепроверяют URL. Очередные доставки используют актуальные URL/секрет/timeout/max_attempts; изменение подписок не отменяет уже созданные доставки.
Scope: webhooks.manage. Bearer-ключ определяет реселлера и среду; подписки не принадлежат одному конкретному API-ключу. Общие правила ошибок и повторов см. руководство надёжности.
Scopes: webhooks.manage
Параметры
webhookUuid
Расположение: path. Обязательный. UUID из ответа API. Передавайте корректную строку UUID. Ресурс другого реселлера или среды не раскрывается.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Idempotency-Key
Расположение: header. Обязательный. Обязателен для POST/PUT/PATCH/DELETE, включая check, sync, test, rotate-secret. После trim 1..160 символов. Один ключ на логическую операцию и API-ключ. Повторите те же method/path/query и байты JSON. TTL HTTP replay по умолчанию 24 часа от первого резервирования; не продлевается. Не переиспользуйте ключ для новой операции, доменная задача дополнительно сохраняет связь с ним.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | minLength: 1; maxLength: 160 |
Пример
json
"webhook-create-20261005-0001"Тело запроса
Обязательное.
application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: [] | Частичное изменение. Пропущенные поля сохраняются; null для перечисленных полей запрещён. Пустой объект допустим, но выполняется проверка URL. Для отключения достаточно status=disabled. Схема: WebhookUpdate |
$.name | string | Нет | minLength: 2; maxLength: 255 | Название для различения получателей. |
$.url | string | Нет | format: "uri"; maxLength: 2048 | Публичный HTTPS URL. Все DNS A/AAAA должны быть глобальными адресами. Запрещены localhost, private/reserved/multicast/NAT64, userinfo, fragment. Redirect не выполняется. Сертификат и hostname проверяются. |
$.event_subscriptions | array | Нет | minItems: 1; maxItems: 100 | Точные имена, не wildcard. Дубликаты удаляются при сохранении. Регистрация имени не гарантирует наличие отправителя. |
$.event_subscriptions[] | string | Да | enum: "customer.created", "customer.updated", "domain.created", "domain.registration.updated", "domain.operation.updated", "domain.updated", "domain.nameservers.updated", "domain.contacts.updated", "domain.verification.submitted", "domain.verification.updated", "domain.renewed", "domain.auto_renew.failed", "domain.transfer.requested", "domain.transfer.updated", "hosting.created", "hosting.updated", "order.created", "order.updated", "invoice.created", "invoice.updated", "payment.completed", "service.updated", "ticket.created", "ticket.updated", "webhook.test" | Допустимые подписки. Девять имён зарезервированы без действующих отправителей: domain.nameservers.updated, domain.contacts.updated, domain.renewed, domain.transfer.requested, hosting.created, hosting.updated, invoice.created, invoice.updated, payment.completed. Не ждите их для завершения операций. Схема: WebhookEventType |
$.timeout_seconds | integer | Нет | minimum: 1; maximum: 30; default: 10 | Общий timeout одной попытки в секундах. Default 10, может изменяться провайдером. Connect timeout min(5,timeout_seconds). |
$.max_attempts | integer | Нет | minimum: 1; maximum: 20; default: 8 | Максимум попыток, включая первую, по умолчанию 8 (настройка провайдера). После исчерпания статус failed, не бесконечные повторы. |
$.status | string | Нет | enum: "active", "disabled" | Выключение не удаляет настройки. Повторное включение не возвращает автоматически пропущенные события. |
default
json
{
"status": "disabled"
}bash
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${WEBHOOK_UUID:?Set WEBHOOK_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"
curl --request PATCH "$API_BASE_URL/webhooks/${WEBHOOK_UUID}" \
--connect-timeout 5 --max-time 20 --fail-with-body \
--header "Authorization: Bearer $RESELLER_API_TOKEN" \
--header 'Accept: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "disabled"
}'php
<?php
declare(strict_types=1);
// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
$value = getenv($name);
if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
throw new RuntimeException('Set a valid environment variable: ' . $name);
}
return $value;
}
$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/webhooks/{webhookUuid}';
$path = str_replace('{webhookUuid}', rawurlencode(requiredEnv('WEBHOOK_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
'Accept: application/json',
'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
'Content-Type: application/json',
];
$body = '{
"status": "disabled"
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
throw new RuntimeException('Cannot initialize cURL.');
}
try {
if (!curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 20,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
if (str_starts_with($line, 'HTTP/')) {
$responseHeaders = [];
} elseif (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
])) {
throw new RuntimeException('Cannot configure cURL.');
}
$raw = curl_exec($handle);
if ($raw === false) {
throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
}
$status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
try {
$data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $error) {
if ($status >= 200 && $status < 300) {
throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
}
}
}
if ($status < 200 || $status >= 300) {
// Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;js
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
const value = process.env[name];
if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/webhooks/{webhookUuid}";
path = path.replaceAll("{webhookUuid}", encodeURIComponent(requiredEnv("WEBHOOK_UUID")));
const url = baseUrl + path;
const body = `{
"status": "disabled"
}`;
const response = await fetch(url, {
method: "PATCH",
redirect: 'manual',
signal: AbortSignal.timeout(20_000),
headers: {
Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
Accept: 'application/json',
'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
"Content-Type": "application/json",
},
body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
try { data = JSON.parse(raw); }
catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
// Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);python
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener
def required_env(name):
value = os.environ.get(name, "")
if not value or "\r" in value or "\n" in value:
raise RuntimeError("Set a valid environment variable: " + name)
return value
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/webhooks/{webhookUuid}"
path = path.replace("{webhookUuid}", quote(required_env("WEBHOOK_UUID"), safe=""))
url = base_url + path
headers = {
"Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
"Accept": "application/json",
"Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
"Content-Type": "application/json",
}
body = "{\n \"status\": \"disabled\"\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="PATCH")
opener = build_opener(NoRedirect())
try:
response = opener.open(request, timeout=20)
except HTTPError as error:
response = error # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
status = response.status
request_id = response.headers.get("X-Request-ID")
retry_after = response.headers.get("Retry-After")
raw = response.read()
data = None
if raw and status not in (204, 205):
try:
data = json.loads(raw)
except (ValueError, UnicodeDecodeError):
if 200 <= status < 300:
raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
# Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)go
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strings"
"time"
)
func requiredEnv(name string) string {
value := os.Getenv(name)
if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
return value
}
func main() {
baseURL := os.Getenv("API_BASE_URL")
if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
path := "/webhooks/{webhookUuid}"
value0 := requiredEnv("WEBHOOK_UUID")
path = strings.ReplaceAll(path, "{webhookUuid}", url.PathEscape(value0))
endpoint := strings.TrimRight(baseURL, "/") + path
request, err := http.NewRequest("PATCH", endpoint, strings.NewReader("{\n \"status\": \"disabled\"\n}"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
request.Header.Set("Accept", "application/json")
request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
request.Header.Set("Content-Type", "application/json")
client := &http.Client{
Timeout: 20 * time.Second,
CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
}
response, err := client.Do(request)
if err != nil { panic("Transport failure; operation result may be unknown") }
defer response.Body.Close()
raw, err := io.ReadAll(response.Body)
if err != nil { panic("Response read failed; operation result may be unknown") }
requestID := response.Header.Get("X-Request-ID")
retryAfter := response.Header.Get("Retry-After")
var data any
if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
decoder := json.NewDecoder(strings.NewReader(string(raw)))
decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
// Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
}
// data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
fmt.Println("HTTP", response.StatusCode)
}java
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
public class RequestExample {
private static String requiredEnv(String name) {
String value = System.getenv(name);
if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
throw new IllegalStateException("Set a valid environment variable: " + name);
}
return value;
}
private static String envOr(String name, String fallback) {
String value = System.getenv(name);
return value == null || value.isEmpty() ? fallback : value;
}
public static void main(String[] args) throws Exception {
String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
String path = "/webhooks/{webhookUuid}";
path = path.replace("{webhookUuid}", URLEncoder.encode(requiredEnv("WEBHOOK_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
URI uri = URI.create(baseUrl + path);
String body = "{\n \"status\": \"disabled\"\n}";
HttpRequest request = HttpRequest.newBuilder(uri)
.timeout(Duration.ofSeconds(20))
.header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
.header("Accept", "application/json")
.header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
.build();
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(5))
.followRedirects(HttpClient.Redirect.NEVER)
.build();
// Reuse HttpClient in production. A timeout may mean an unknown write result.
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
int status = response.statusCode();
String requestId = response.headers().firstValue("X-Request-ID").orElse("");
String retryAfter = response.headers().firstValue("Retry-After").orElse("");
String responseBody = (status == 204 || status == 205) ? "" : response.body();
if (status < 200 || status >= 300) {
// Decode responseBody with your JSON library; schedule 429 using retryAfter.
throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
}
// Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
// Do not parse an empty 204 body; 202 means accepted, not completed.
System.out.println("HTTP " + status);
}
}csharp
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
static string RequiredEnv(string name)
{
string? value = Environment.GetEnvironmentVariable(name);
if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
throw new InvalidOperationException("Set a valid environment variable: " + name);
return value;
}
string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/webhooks/{webhookUuid}";
path = path.Replace("{webhookUuid}", Uri.EscapeDataString(RequiredEnv("WEBHOOK_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("PATCH"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n \"status\": \"disabled\"\n}", Encoding.UTF8, "application/json");
// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
// Inspect data; schedule 429 using retryAfter and preserve the same key/body.
throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");enable
json
{
"status": "active"
}bash
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${WEBHOOK_UUID:?Set WEBHOOK_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"
curl --request PATCH "$API_BASE_URL/webhooks/${WEBHOOK_UUID}" \
--connect-timeout 5 --max-time 20 --fail-with-body \
--header "Authorization: Bearer $RESELLER_API_TOKEN" \
--header 'Accept: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"status": "active"
}'php
<?php
declare(strict_types=1);
// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
$value = getenv($name);
if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
throw new RuntimeException('Set a valid environment variable: ' . $name);
}
return $value;
}
$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/webhooks/{webhookUuid}';
$path = str_replace('{webhookUuid}', rawurlencode(requiredEnv('WEBHOOK_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
'Accept: application/json',
'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
'Content-Type: application/json',
];
$body = '{
"status": "active"
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
throw new RuntimeException('Cannot initialize cURL.');
}
try {
if (!curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 20,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
if (str_starts_with($line, 'HTTP/')) {
$responseHeaders = [];
} elseif (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
])) {
throw new RuntimeException('Cannot configure cURL.');
}
$raw = curl_exec($handle);
if ($raw === false) {
throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
}
$status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
try {
$data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $error) {
if ($status >= 200 && $status < 300) {
throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
}
}
}
if ($status < 200 || $status >= 300) {
// Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;js
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
const value = process.env[name];
if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/webhooks/{webhookUuid}";
path = path.replaceAll("{webhookUuid}", encodeURIComponent(requiredEnv("WEBHOOK_UUID")));
const url = baseUrl + path;
const body = `{
"status": "active"
}`;
const response = await fetch(url, {
method: "PATCH",
redirect: 'manual',
signal: AbortSignal.timeout(20_000),
headers: {
Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
Accept: 'application/json',
'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
"Content-Type": "application/json",
},
body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
try { data = JSON.parse(raw); }
catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
// Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);python
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener
def required_env(name):
value = os.environ.get(name, "")
if not value or "\r" in value or "\n" in value:
raise RuntimeError("Set a valid environment variable: " + name)
return value
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/webhooks/{webhookUuid}"
path = path.replace("{webhookUuid}", quote(required_env("WEBHOOK_UUID"), safe=""))
url = base_url + path
headers = {
"Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
"Accept": "application/json",
"Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
"Content-Type": "application/json",
}
body = "{\n \"status\": \"active\"\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="PATCH")
opener = build_opener(NoRedirect())
try:
response = opener.open(request, timeout=20)
except HTTPError as error:
response = error # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
status = response.status
request_id = response.headers.get("X-Request-ID")
retry_after = response.headers.get("Retry-After")
raw = response.read()
data = None
if raw and status not in (204, 205):
try:
data = json.loads(raw)
except (ValueError, UnicodeDecodeError):
if 200 <= status < 300:
raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
# Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)go
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strings"
"time"
)
func requiredEnv(name string) string {
value := os.Getenv(name)
if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
return value
}
func main() {
baseURL := os.Getenv("API_BASE_URL")
if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
path := "/webhooks/{webhookUuid}"
value0 := requiredEnv("WEBHOOK_UUID")
path = strings.ReplaceAll(path, "{webhookUuid}", url.PathEscape(value0))
endpoint := strings.TrimRight(baseURL, "/") + path
request, err := http.NewRequest("PATCH", endpoint, strings.NewReader("{\n \"status\": \"active\"\n}"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
request.Header.Set("Accept", "application/json")
request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
request.Header.Set("Content-Type", "application/json")
client := &http.Client{
Timeout: 20 * time.Second,
CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
}
response, err := client.Do(request)
if err != nil { panic("Transport failure; operation result may be unknown") }
defer response.Body.Close()
raw, err := io.ReadAll(response.Body)
if err != nil { panic("Response read failed; operation result may be unknown") }
requestID := response.Header.Get("X-Request-ID")
retryAfter := response.Header.Get("Retry-After")
var data any
if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
decoder := json.NewDecoder(strings.NewReader(string(raw)))
decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
// Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
}
// data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
fmt.Println("HTTP", response.StatusCode)
}java
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
public class RequestExample {
private static String requiredEnv(String name) {
String value = System.getenv(name);
if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
throw new IllegalStateException("Set a valid environment variable: " + name);
}
return value;
}
private static String envOr(String name, String fallback) {
String value = System.getenv(name);
return value == null || value.isEmpty() ? fallback : value;
}
public static void main(String[] args) throws Exception {
String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
String path = "/webhooks/{webhookUuid}";
path = path.replace("{webhookUuid}", URLEncoder.encode(requiredEnv("WEBHOOK_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
URI uri = URI.create(baseUrl + path);
String body = "{\n \"status\": \"active\"\n}";
HttpRequest request = HttpRequest.newBuilder(uri)
.timeout(Duration.ofSeconds(20))
.header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
.header("Accept", "application/json")
.header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
.build();
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(5))
.followRedirects(HttpClient.Redirect.NEVER)
.build();
// Reuse HttpClient in production. A timeout may mean an unknown write result.
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
int status = response.statusCode();
String requestId = response.headers().firstValue("X-Request-ID").orElse("");
String retryAfter = response.headers().firstValue("Retry-After").orElse("");
String responseBody = (status == 204 || status == 205) ? "" : response.body();
if (status < 200 || status >= 300) {
// Decode responseBody with your JSON library; schedule 429 using retryAfter.
throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
}
// Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
// Do not parse an empty 204 body; 202 means accepted, not completed.
System.out.println("HTTP " + status);
}
}csharp
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
static string RequiredEnv(string name)
{
string? value = Environment.GetEnvironmentVariable(name);
if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
throw new InvalidOperationException("Set a valid environment variable: " + name);
return value;
}
string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/webhooks/{webhookUuid}";
path = path.Replace("{webhookUuid}", Uri.EscapeDataString(RequiredEnv("WEBHOOK_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("PATCH"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n \"status\": \"active\"\n}", Encoding.UTF8, "application/json");
// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
// Inspect data; schedule 429 using retryAfter and preserve the same key/body.
throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");change
json
{
"name": "Renewal monitor",
"url": "https://reseller.example/webhooks/domains",
"event_subscriptions": [
"domain.operation.updated"
],
"timeout_seconds": 15,
"max_attempts": 10
}bash
API_BASE_URL='https://api.b.websoft.kz/api/reseller/v1'
: "${RESELLER_API_TOKEN:?Set RESELLER_API_TOKEN in your environment}"
: "${WEBHOOK_UUID:?Set WEBHOOK_UUID}"
: "${IDEMPOTENCY_KEY:?Set one persisted unique key per logical request}"
curl --request PATCH "$API_BASE_URL/webhooks/${WEBHOOK_UUID}" \
--connect-timeout 5 --max-time 20 --fail-with-body \
--header "Authorization: Bearer $RESELLER_API_TOKEN" \
--header 'Accept: application/json' \
--header "Idempotency-Key: $IDEMPOTENCY_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Renewal monitor",
"url": "https://reseller.example/webhooks/domains",
"event_subscriptions": [
"domain.operation.updated"
],
"timeout_seconds": 15,
"max_attempts": 10
}'php
<?php
declare(strict_types=1);
// PHP 8.0+; extensions: curl, json. Persist the key/body before any write.
function requiredEnv(string $name): string
{
$value = getenv($name);
if ($value === false || $value === '' || str_contains($value, "\r") || str_contains($value, "\n")) {
throw new RuntimeException('Set a valid environment variable: ' . $name);
}
return $value;
}
$baseUrl = rtrim(getenv('API_BASE_URL') ?: 'https://api.b.websoft.kz/api/reseller/v1', '/');
$path = '/webhooks/{webhookUuid}';
$path = str_replace('{webhookUuid}', rawurlencode(requiredEnv('WEBHOOK_UUID')), $path);
$url = $baseUrl . $path;
$headers = [
'Authorization: Bearer ' . requiredEnv('RESELLER_API_TOKEN'),
'Accept: application/json',
'Idempotency-Key: ' . requiredEnv('IDEMPOTENCY_KEY'),
'Content-Type: application/json',
];
$body = '{
"name": "Renewal monitor",
"url": "https://reseller.example/webhooks/domains",
"event_subscriptions": [
"domain.operation.updated"
],
"timeout_seconds": 15,
"max_attempts": 10
}';
$responseHeaders = [];
$handle = curl_init($url);
if ($handle === false) {
throw new RuntimeException('Cannot initialize cURL.');
}
try {
if (!curl_setopt_array($handle, [
CURLOPT_CUSTOMREQUEST => 'PATCH',
CURLOPT_HTTPHEADER => $headers,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_FOLLOWLOCATION => false,
CURLOPT_CONNECTTIMEOUT => 5,
CURLOPT_TIMEOUT => 20,
CURLOPT_SSL_VERIFYPEER => true,
CURLOPT_SSL_VERIFYHOST => 2,
CURLOPT_POSTFIELDS => $body,
CURLOPT_HEADERFUNCTION => static function (CurlHandle $curl, string $line) use (&$responseHeaders): int {
if (str_starts_with($line, 'HTTP/')) {
$responseHeaders = [];
} elseif (str_contains($line, ':')) {
[$name, $value] = explode(':', $line, 2);
$responseHeaders[strtolower(trim($name))] = trim($value);
}
return strlen($line);
},
])) {
throw new RuntimeException('Cannot configure cURL.');
}
$raw = curl_exec($handle);
if ($raw === false) {
throw new RuntimeException('Transport failure; result may be unknown. cURL code: ' . curl_errno($handle));
}
$status = (int) curl_getinfo($handle, CURLINFO_RESPONSE_CODE);
} finally {
unset($handle);
}
$requestId = $responseHeaders['x-request-id'] ?? null;
$retryAfter = $responseHeaders['retry-after'] ?? null;
$data = null;
if ($raw !== '' && !in_array($status, [204, 205], true)) {
try {
$data = json_decode($raw, true, 512, JSON_THROW_ON_ERROR);
} catch (JsonException $error) {
if ($status >= 200 && $status < 300) {
throw new RuntimeException('Unexpected non-JSON success response.', 0, $error);
}
}
}
if ($status < 200 || $status >= 300) {
// Inspect $data['error']; queue 429 using $retryAfter, never create a new write key blindly.
throw new RuntimeException('HTTP ' . $status . '; request_id=' . ($requestId ?? '-') . '; retry_after=' . ($retryAfter ?? '-'));
}
// $data contains the decoded response; 202 means accepted, not completed.
echo 'HTTP ' . $status . PHP_EOL;js
// Node.js 22+; save as request.mjs. No third-party dependencies.
function requiredEnv(name) {
const value = process.env[name];
if (!value || /[\r\n]/u.test(value)) throw new Error('Set a valid environment variable: ' + name);
return value;
}
const baseUrl = (process.env.API_BASE_URL || "https://api.b.websoft.kz/api/reseller/v1").replace(/\/$/u, '');
let path = "/webhooks/{webhookUuid}";
path = path.replaceAll("{webhookUuid}", encodeURIComponent(requiredEnv("WEBHOOK_UUID")));
const url = baseUrl + path;
const body = `{
"name": "Renewal monitor",
"url": "https://reseller.example/webhooks/domains",
"event_subscriptions": [
"domain.operation.updated"
],
"timeout_seconds": 15,
"max_attempts": 10
}`;
const response = await fetch(url, {
method: "PATCH",
redirect: 'manual',
signal: AbortSignal.timeout(20_000),
headers: {
Authorization: 'Bearer ' + requiredEnv('RESELLER_API_TOKEN'),
Accept: 'application/json',
'Idempotency-Key': requiredEnv('IDEMPOTENCY_KEY'),
"Content-Type": "application/json",
},
body,
});
const requestId = response.headers.get('x-request-id');
const retryAfter = response.headers.get('retry-after');
const raw = await response.text();
let data = null;
if (raw && ![204, 205].includes(response.status)) {
try { data = JSON.parse(raw); }
catch (cause) { if (response.ok) throw new Error('Unexpected non-JSON success response.', { cause }); }
}
if (!response.ok) {
// Inspect data?.error; schedule 429 using retryAfter. Do not generate another write key.
throw new Error('HTTP ' + response.status + '; request_id=' + requestId + '; retry_after=' + retryAfter);
}
// A timeout may have an unknown result. No automatic mutation retry in this example.
// data contains the response; 202 means accepted, not completed.
console.log('HTTP', response.status);python
# Python 3.10+; standard library only.
import json
import os
from urllib.error import HTTPError
from urllib.parse import quote
from urllib.request import HTTPRedirectHandler, Request, build_opener
def required_env(name):
value = os.environ.get(name, "")
if not value or "\r" in value or "\n" in value:
raise RuntimeError("Set a valid environment variable: " + name)
return value
class NoRedirect(HTTPRedirectHandler):
def redirect_request(self, req, fp, code, msg, headers, newurl):
return None
base_url = os.environ.get("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").rstrip("/")
path = "/webhooks/{webhookUuid}"
path = path.replace("{webhookUuid}", quote(required_env("WEBHOOK_UUID"), safe=""))
url = base_url + path
headers = {
"Authorization": "Bearer " + required_env("RESELLER_API_TOKEN"),
"Accept": "application/json",
"Idempotency-Key": required_env("IDEMPOTENCY_KEY"),
"Content-Type": "application/json",
}
body = "{\n \"name\": \"Renewal monitor\",\n \"url\": \"https://reseller.example/webhooks/domains\",\n \"event_subscriptions\": [\n \"domain.operation.updated\"\n ],\n \"timeout_seconds\": 15,\n \"max_attempts\": 10\n}".encode("utf-8")
request = Request(url, data=body, headers=headers, method="PATCH")
opener = build_opener(NoRedirect())
try:
response = opener.open(request, timeout=20)
except HTTPError as error:
response = error # HTTP failure still has a response body and headers.
# Network/timeout exceptions propagate: a write may already have been accepted.
with response:
status = response.status
request_id = response.headers.get("X-Request-ID")
retry_after = response.headers.get("Retry-After")
raw = response.read()
data = None
if raw and status not in (204, 205):
try:
data = json.loads(raw)
except (ValueError, UnicodeDecodeError):
if 200 <= status < 300:
raise RuntimeError("Unexpected non-JSON success response.")
if not 200 <= status < 300:
# Inspect data['error']; schedule 429 with retry_after, keeping the same persisted key.
raise RuntimeError(f"HTTP {status}; request_id={request_id}; retry_after={retry_after}")
# data contains the response. Do not log secrets/PII; 202 is not completion.
print("HTTP", status)go
// Go 1.22+; standard library only. Save as main.go and run: go run main.go
package main
import (
"encoding/json"
"fmt"
"io"
"net/http"
"net/url"
"os"
"strings"
"time"
)
func requiredEnv(name string) string {
value := os.Getenv(name)
if value == "" || strings.ContainsAny(value, "\r\n") { panic("Set a valid environment variable: " + name) }
return value
}
func main() {
baseURL := os.Getenv("API_BASE_URL")
if baseURL == "" { baseURL = "https://api.b.websoft.kz/api/reseller/v1" }
path := "/webhooks/{webhookUuid}"
value0 := requiredEnv("WEBHOOK_UUID")
path = strings.ReplaceAll(path, "{webhookUuid}", url.PathEscape(value0))
endpoint := strings.TrimRight(baseURL, "/") + path
request, err := http.NewRequest("PATCH", endpoint, strings.NewReader("{\n \"name\": \"Renewal monitor\",\n \"url\": \"https://reseller.example/webhooks/domains\",\n \"event_subscriptions\": [\n \"domain.operation.updated\"\n ],\n \"timeout_seconds\": 15,\n \"max_attempts\": 10\n}"))
if err != nil { panic(err) }
request.Header.Set("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
request.Header.Set("Accept", "application/json")
request.Header.Set("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
request.Header.Set("Content-Type", "application/json")
client := &http.Client{
Timeout: 20 * time.Second,
CheckRedirect: func(req *http.Request, via []*http.Request) error { return http.ErrUseLastResponse },
}
response, err := client.Do(request)
if err != nil { panic("Transport failure; operation result may be unknown") }
defer response.Body.Close()
raw, err := io.ReadAll(response.Body)
if err != nil { panic("Response read failed; operation result may be unknown") }
requestID := response.Header.Get("X-Request-ID")
retryAfter := response.Header.Get("Retry-After")
var data any
if len(raw) > 0 && response.StatusCode != 204 && response.StatusCode != 205 {
decoder := json.NewDecoder(strings.NewReader(string(raw)))
decoder.UseNumber() // Preserve integer money/identifiers without float rounding.
if err := decoder.Decode(&data); err != nil && response.StatusCode >= 200 && response.StatusCode < 300 { panic("Unexpected non-JSON success response") }
}
if response.StatusCode < 200 || response.StatusCode >= 300 {
// Inspect data; schedule 429 using retryAfter. Never create a new key blindly.
panic(fmt.Sprintf("HTTP %d; request_id=%s; retry_after=%s", response.StatusCode, requestID, retryAfter))
}
// data holds the JSON value; 202 means accepted, not completed. Do not log secrets.
fmt.Println("HTTP", response.StatusCode)
}java
// Java 17+; standard library only. Save as RequestExample.java.
// Run: java RequestExample.java
import java.net.URI;
import java.net.URLEncoder;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.nio.charset.StandardCharsets;
import java.time.Duration;
public class RequestExample {
private static String requiredEnv(String name) {
String value = System.getenv(name);
if (value == null || value.isEmpty() || value.contains("\r") || value.contains("\n")) {
throw new IllegalStateException("Set a valid environment variable: " + name);
}
return value;
}
private static String envOr(String name, String fallback) {
String value = System.getenv(name);
return value == null || value.isEmpty() ? fallback : value;
}
public static void main(String[] args) throws Exception {
String baseUrl = envOr("API_BASE_URL", "https://api.b.websoft.kz/api/reseller/v1").replaceAll("/+$", "");
String path = "/webhooks/{webhookUuid}";
path = path.replace("{webhookUuid}", URLEncoder.encode(requiredEnv("WEBHOOK_UUID"), StandardCharsets.UTF_8).replace("+", "%20"));
URI uri = URI.create(baseUrl + path);
String body = "{\n \"name\": \"Renewal monitor\",\n \"url\": \"https://reseller.example/webhooks/domains\",\n \"event_subscriptions\": [\n \"domain.operation.updated\"\n ],\n \"timeout_seconds\": 15,\n \"max_attempts\": 10\n}";
HttpRequest request = HttpRequest.newBuilder(uri)
.timeout(Duration.ofSeconds(20))
.header("Authorization", "Bearer " + requiredEnv("RESELLER_API_TOKEN"))
.header("Accept", "application/json")
.header("Idempotency-Key", requiredEnv("IDEMPOTENCY_KEY"))
.header("Content-Type", "application/json")
.method("PATCH", HttpRequest.BodyPublishers.ofString(body, StandardCharsets.UTF_8))
.build();
HttpClient client = HttpClient.newBuilder()
.connectTimeout(Duration.ofSeconds(5))
.followRedirects(HttpClient.Redirect.NEVER)
.build();
// Reuse HttpClient in production. A timeout may mean an unknown write result.
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString(StandardCharsets.UTF_8));
int status = response.statusCode();
String requestId = response.headers().firstValue("X-Request-ID").orElse("");
String retryAfter = response.headers().firstValue("Retry-After").orElse("");
String responseBody = (status == 204 || status == 205) ? "" : response.body();
if (status < 200 || status >= 300) {
// Decode responseBody with your JSON library; schedule 429 using retryAfter.
throw new IllegalStateException("HTTP " + status + "; request_id=" + requestId + "; retry_after=" + retryAfter);
}
// Java SE has no JSON object mapper: pass responseBody to your project's JSON parser.
// Do not parse an empty 204 body; 202 means accepted, not completed.
System.out.println("HTTP " + status);
}
}csharp
// C# / .NET 8+ console app; standard library only. Save as Program.cs.
using System;
using System.Net.Http;
using System.Text;
using System.Text.Json;
static string RequiredEnv(string name)
{
string? value = Environment.GetEnvironmentVariable(name);
if (string.IsNullOrEmpty(value) || value.Contains('\r') || value.Contains('\n'))
throw new InvalidOperationException("Set a valid environment variable: " + name);
return value;
}
string baseUrl = (Environment.GetEnvironmentVariable("API_BASE_URL") ?? "https://api.b.websoft.kz/api/reseller/v1").TrimEnd('/');
string path = "/webhooks/{webhookUuid}";
path = path.Replace("{webhookUuid}", Uri.EscapeDataString(RequiredEnv("WEBHOOK_UUID")));
using var handler = new HttpClientHandler { AllowAutoRedirect = false };
using var client = new HttpClient(handler) { Timeout = TimeSpan.FromSeconds(20) };
// Reuse HttpClient (or IHttpClientFactory) in production, not one client per request.
using var request = new HttpRequestMessage(new HttpMethod("PATCH"), baseUrl + path);
request.Headers.Add("Authorization", "Bearer " + RequiredEnv("RESELLER_API_TOKEN"));
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Idempotency-Key", RequiredEnv("IDEMPOTENCY_KEY"));
request.Content = new StringContent("{\n \"name\": \"Renewal monitor\",\n \"url\": \"https://reseller.example/webhooks/domains\",\n \"event_subscriptions\": [\n \"domain.operation.updated\"\n ],\n \"timeout_seconds\": 15,\n \"max_attempts\": 10\n}", Encoding.UTF8, "application/json");
// Transport exceptions may have an unknown result; do not issue a new mutation automatically.
using var response = await client.SendAsync(request);
int status = (int)response.StatusCode;
string requestId = response.Headers.TryGetValues("X-Request-ID", out var ids) ? string.Join(",", ids) : "";
string retryAfter = response.Headers.TryGetValues("Retry-After", out var delays) ? string.Join(",", delays) : "";
string raw = await response.Content.ReadAsStringAsync();
JsonElement? data = null;
if (raw.Length > 0 && status != 204 && status != 205)
{
try { using var document = JsonDocument.Parse(raw); data = document.RootElement.Clone(); }
catch (JsonException) { if (response.IsSuccessStatusCode) throw; }
}
if (!response.IsSuccessStatusCode)
{
// Inspect data; schedule 429 using retryAfter and preserve the same key/body.
throw new HttpRequestException($"HTTP {status}; request_id={requestId}; retry_after={retryAfter}");
}
// data contains JSON, or null for 204. HTTP 202 is not completion.
Console.WriteLine($"HTTP {status}");Ответы
Условия ошибок и восстановление
| HTTP | Код | Когда возникает | Что делать |
|---|---|---|---|
| 401 | unauthenticated | Нет корректного активного Bearer-ключа либо он истёк/отозван. | Получите/исправьте ключ; не повторяйте без изменения причины. |
| 403 | forbidden | Нет scope операции, IP запрещён, API не включён для реселлера или его статус/тариф запрещает запрос. | Сверьте GET /context и разрешения у провайдера. |
| 404 | resource_not_found | API отключён; для UUID-маршрута также ресурс отсутствует, чужой или другой среды. | Проверьте UUID и среду ключа; не перебирайте чужие ресурсы. |
| 429 | rate_limit_exceeded | Исчерпана общая квота этого API-ключа. | Ждите Retry-After секунд плюс jitter; запись повторяйте с тем же Idempotency-Key. |
| 500 | internal_error | Внутренний сбой; некорректный UUID также может не пройти обработку как 422. | Сохраните X-Request-ID, передавайте валидный UUID. После записи сначала сверка состояния, не новая операция. |
| 409 | conflict | Ключ уже обрабатывается или ранее использован с другим method/path/query/body. | Не меняйте ключ после неизвестного результата. Дождитесь исходной попытки; исправленный запрос оформляйте новым ключом только после сверки. |
| 422 | validation_failed | Idempotency-Key отсутствует/пуст/длиннее 160 символов. | Передайте уникальный ключ на логическую операцию. |
| 422 | validation_failed | Неверные name/url/events/timeout/max_attempts/status; URL не публичный HTTPS, DNS не разрешается или есть запрещённый адрес. | Исправьте поля из details, DNS и сертификат; запрос с исправленным телом отправляйте с новым ключом. |
HTTP 200
Успешный ответ.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Заголовок X-RateLimit-Limit: Лимит API-ключа на 60 секунд. После прохождения ограничителя, включая replay. Отсутствует в собственной ветке 429 и при раннем отказе.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | integer | Да | minimum: 1 |
text
X-RateLimit-Limit: 120Заголовок X-RateLimit-Remaining: Остаток после запроса. Снимок, не гарантия при конкуренции. Отсутствует в собственной ветке 429 и при раннем отказе.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | integer | Да | minimum: 0 |
text
X-RateLimit-Remaining: 119Заголовок Idempotency-Replayed: Только при возврате сохранённого HTTP-ответа: true, не false. Отсутствие не доказывает, что доменная операция ранее не выполнялась.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | const: "true" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["data"] | Одна подписка. Схема: WebhookResponse |
$.data | object | Да | required: ["uuid","environment","name","url","event_subscriptions","timeout_seconds","max_attempts","status","rotated_at","disabled_at","created_at"] | Настройки webhook; signing_secret здесь никогда не возвращается. Схема: Webhook |
$.data.uuid | string | Да | format: "uuid" | UUID подписки. |
$.data.environment | string | Да | enum: "test", "live" | Среда подписки; события другой среды не доставляются. |
$.data.name | string | Да | minLength: 2; maxLength: 255 | Название для различения получателей. |
$.data.url | string | Да | format: "uri"; maxLength: 2048 | Публичный HTTPS URL. Все DNS A/AAAA должны быть глобальными адресами. Запрещены localhost, private/reserved/multicast/NAT64, userinfo, fragment. Redirect не выполняется. Сертификат и hostname проверяются. |
$.data.event_subscriptions | array | Да | minItems: 1; maxItems: 100 | Точные имена, не wildcard. Дубликаты удаляются при сохранении. Регистрация имени не гарантирует наличие отправителя. |
$.data.event_subscriptions[] | string | Да | enum: "customer.created", "customer.updated", "domain.created", "domain.registration.updated", "domain.operation.updated", "domain.updated", "domain.nameservers.updated", "domain.contacts.updated", "domain.verification.submitted", "domain.verification.updated", "domain.renewed", "domain.auto_renew.failed", "domain.transfer.requested", "domain.transfer.updated", "hosting.created", "hosting.updated", "order.created", "order.updated", "invoice.created", "invoice.updated", "payment.completed", "service.updated", "ticket.created", "ticket.updated", "webhook.test" | Допустимые подписки. Девять имён зарезервированы без действующих отправителей: domain.nameservers.updated, domain.contacts.updated, domain.renewed, domain.transfer.requested, hosting.created, hosting.updated, invoice.created, invoice.updated, payment.completed. Не ждите их для завершения операций. Схема: WebhookEventType |
$.data.timeout_seconds | integer | Да | minimum: 1; maximum: 30; default: 10 | Общий timeout одной попытки в секундах. Default 10, может изменяться провайдером. Connect timeout min(5,timeout_seconds). |
$.data.max_attempts | integer | Да | minimum: 1; maximum: 20; default: 8 | Максимум попыток, включая первую, по умолчанию 8 (настройка провайдера). После исчерпания статус failed, не бесконечные повторы. |
$.data.status | string | Да | enum: "active", "disabled" | Активность получателя. |
$.data.rotated_at | string / null | Да | format: "date-time" | Последняя ротация секрета, null до первой ротации. |
$.data.disabled_at | string / null | Да | format: "date-time" | Последнее отключение; null для активного. |
$.data.created_at | string / null | Да | format: "date-time" | Создание подписки. |
default (200)
json
{
"data": {
"uuid": "22222222-2222-4222-8222-222222222222",
"environment": "test",
"name": "Domain events",
"url": "https://reseller.example/webhooks/billing",
"event_subscriptions": [
"domain.operation.updated",
"domain.registration.updated",
"domain.verification.updated"
],
"timeout_seconds": 10,
"max_attempts": 8,
"status": "disabled",
"rotated_at": null,
"disabled_at": "2026-10-05T10:00:00+00:00",
"created_at": "2026-10-05T09:00:00+00:00"
}
}HTTP 401
Отсутствует, неверен, отозван или просрочен Bearer-ключ.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (401)
json
{
"error": {
"code": "unauthenticated",
"message": "API credential is missing or invalid.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 403
Нет scope, IP не разрешён, тариф/режим/статус реселлера запрещает действие либо test-ключ обращается к live-only ресурсу.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (403)
json
{
"error": {
"code": "forbidden",
"message": "Source IP address is not allowed.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}supportTest (403)
json
{
"error": {
"code": "forbidden",
"message": "Support is available only to live credentials.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 404
Ресурс недоступен в контексте или весь reseller API отключён. Не отличайте чужое от отсутствующего.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (404)
json
{
"error": {
"code": "resource_not_found",
"message": "Not Found",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 409
Конфликт ключа идемпотентности или состояния. Устраните причину.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (409)
json
{
"error": {
"code": "conflict",
"message": "A request with this Idempotency-Key is already processing.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}changedRequest (409)
json
{
"error": {
"code": "conflict",
"message": "Idempotency-Key was already used with a different request.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 422
Ошибка данных или обязательного заголовка. details может быть [].
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (422)
json
{
"error": {
"code": "validation_failed",
"message": "A valid Idempotency-Key header is required.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}fields (422)
json
{
"error": {
"code": "validation_failed",
"message": "The name field is required.",
"details": {
"name": [
"The name field is required."
]
},
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 429
Квота API-ключа исчерпана. Ждите Retry-After. Собственный 429 не содержит X-RateLimit-Limit/Remaining/Reset.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Заголовок Retry-After: На 429 API: целые секунды до сброса окна, не дата/Unix timestamp. При 0 добавьте jitter. Proxy может вернуть HTTP-date.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | pattern: "^[0-9]+$" |
text
Retry-After: 42Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (429)
json
{
"error": {
"code": "rate_limit_exceeded",
"message": "API rate limit exceeded.",
"details": {
"retry_after": 42
},
"request_id": "11111111-1111-4111-8111-111111111111"
}
}HTTP 500
Этот HTTP-ответ не определяет результат записи. Сначала сверка; повтор только с прежним ключом и точным телом.
Заголовок X-Request-ID: UUID текущего запроса. Корректный входной X-Request-ID принимается в нижнем регистре, иначе создаётся новый. Не гарантирован для proxy/неизвестного маршрута.
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | string | Да | format: "uuid" |
Content-Type: application/json
| Поле | Тип | Обязательно в родителе | Ограничения | Описание |
|---|---|---|---|---|
$ | object | Да | required: ["error"] | Собственный JSON-конверт API, не RFC 9457. Структура и code не зависят от языка; message и details предназначены человеку. До выбора маршрута и на proxy этот конверт не гарантирован. Схема: ErrorEnvelope |
$.error | object | Да | required: ["code","message","details","request_id"] | |
$.error.code | string | Да | Машинный код; не извлекайте причину из message. | |
$.error.message | string | Да | Человекочитаемое, частично локализуемое сообщение; не стабильный идентификатор ошибки. | |
$.error.details | oneOf | Да | Без подробностей возвращается [], не null и не {}. Валидация: {поле:[сообщения]}. Квота: {retry_after:секунды}. | |
$.error.details (oneOf 1) | array | Да | maxItems: 0 | |
$.error.details (oneOf 2) | object | Да | ||
$.error.details (oneOf 2).* | array | Нет | ||
$.error.details (oneOf 2).*[] | string | Да | ||
$.error.details (oneOf 3) | object | Да | required: ["retry_after"]; Дополнительные поля запрещены | |
$.error.details (oneOf 3).retry_after | integer | Да | minimum: 0 | |
$.error.request_id | string / null | Да | format: "uuid" | UUID для диагностики или null без контекста. При HTTP replay тело может содержать исходный ID, заголовок X-Request-ID относится к текущей попытке. |
default (500)
json
{
"error": {
"code": "internal_error",
"message": "The request could not be completed.",
"details": [],
"request_id": "11111111-1111-4111-8111-111111111111"
}
}