Обновление адреса webhook через API

curl

curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscribed_events": [
      "status.updated",
      "data.updated",
      "transaction.created"
    ]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", {
  enabled: false,
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
	Enabled: didit.Bool(false),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.WebhooksDestinationsUpdateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder()
        .enabled(false)
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
    'enabled' => false,
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams
{
    Enabled = false,
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "label": "Production session webhooks",
  "url": "https://yourapp.com/webhooks/didit",
  "enabled": false,
  "webhook_version": "v3",
  "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ",
  "secret_last4": "0xnQ",
  "previous_secret_expires_at": null,
  "subscribed_events": [
    "status.updated",
    "data.updated"
  ],
  "created_by_email": null,
  "created_by_name": null,
  "created_at": "2026-01-04T08:00:00Z",
  "updated_at": "2026-05-17T11:02:55Z",
  "health_status": "healthy",
  "failing_streak": 0,
  "failing_since": null,
  "last_success_at": "2026-05-17T09:21:18Z",
  "environment": "live",
  "summary": {
    "total_deliveries": 12453,
    "failed_deliveries": 14,
    "error_rate_percentage": 0,
    "min_response_time_ms": 41,
    "avg_response_time_ms": 187,
    "max_response_time_ms": 2103,
    "last_delivery_at": "2026-05-17T09:21:18Z",
    "metrics_window_days": 30
  }
}

PATCH

webhook

destinations

{destination_uuid}

curl

curl -X PATCH 'https://verification.didit.me/v3/webhook/destinations/11111111-2222-3333-4444-555555555555/' \
  -H 'x-api-key: YOUR_API_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "subscribed_events": [
      "status.updated",
      "data.updated",
      "transaction.created"
    ]
  }'

import Didit from "@didit-protocol/sdk-node";

// Reads DIDIT_API_KEY.
const didit = new Didit();

const result = await didit.webhooks.destinations.update("11111111-2222-3333-4444-555555555555", {
  enabled: false,
});
console.log(result);

ctx := context.Background()
// Reads DIDIT_API_KEY.
client := didit.NewClient()

result, err := client.Webhooks.Destinations.Update(ctx, "11111111-2222-3333-4444-555555555555", didit.WebhooksDestinationsUpdateParams{
	Enabled: didit.Bool(false),
})
if err != nil {
	log.Fatal(err)
}
fmt.Printf("%+v\n", result)

import me.didit.Didit;
import me.didit.types.WebhooksDestinationsUpdateParams;

// Reads DIDIT_API_KEY.
Didit client = new Didit();

var result = client.webhooks().destinations().update("11111111-2222-3333-4444-555555555555", WebhooksDestinationsUpdateParams.builder()
        .enabled(false)
        .build());
System.out.println(result);

<?php

require 'vendor/autoload.php';

use Didit\DiditClient;

// Reads DIDIT_API_KEY.
$didit = new DiditClient();

$result = $didit->webhooks->destinations->update('11111111-2222-3333-4444-555555555555', [
    'enabled' => false,
]);
print_r($result->toArray());

using System;
using System.Text.Json;
using Didit;

// Reads DIDIT_API_KEY.
using var client = new DiditClient();

var result = await client.Webhooks.Destinations.UpdateAsync("11111111-2222-3333-4444-555555555555", new WebhooksDestinationsUpdateParams
{
    Enabled = false,
});
Console.WriteLine(JsonSerializer.Serialize(result));

{
  "uuid": "11111111-2222-3333-4444-555555555555",
  "label": "Production session webhooks",
  "url": "https://yourapp.com/webhooks/didit",
  "enabled": false,
  "webhook_version": "v3",
  "secret_shared_key": "tno2NTeRC1ZK3sBOYlBJDyEzBVENl3pQ1AcZyAW0xnQ",
  "secret_last4": "0xnQ",
  "previous_secret_expires_at": null,
  "subscribed_events": [
    "status.updated",
    "data.updated"
  ],
  "created_by_email": null,
  "created_by_name": null,
  "created_at": "2026-01-04T08:00:00Z",
  "updated_at": "2026-05-17T11:02:55Z",
  "health_status": "healthy",
  "failing_streak": 0,
  "failing_since": null,
  "last_success_at": "2026-05-17T09:21:18Z",
  "environment": "live",
  "summary": {
    "total_deliveries": 12453,
    "failed_deliveries": 14,
    "error_rate_percentage": 0,
    "min_response_time_ms": 41,
    "avg_response_time_ms": 187,
    "max_response_time_ms": 2103,
    "last_delivery_at": "2026-05-17T09:21:18Z",
    "metrics_window_days": 30
  }
}

Используйте этот endpoint, чтобы изменить, куда адрес назначения отправляет webhook, и какие события он получает.

Обновление `subscribed_events`

Когда вы передаёте subscribed_events, укажите полный список событий, на которые должна сохраняться подписка после обновления. Массив заменяет предыдущий набор подписок.

{
  "subscribed_events": [
    "status.updated",
    "data.updated",
    "transaction.created",
    "transaction.status.updated"
  ]
}

Поддерживаемые значения:

Событие	Что означает
`status.updated`	Изменился статус сессии проверки пользователей (KYC) или верификации бизнеса (KYB).
`data.updated`	Данные верификации сессии изменились после её создания.
`user.status.updated`	Изменился статус сущности пользователя.
`user.data.updated`	Изменились данные сущности пользователя.
`business.status.updated`	Изменился статус сущности компании.
`business.data.updated`	Изменились данные сущности компании.
`activity.created`	Принимается, но на продакшн-трафике сегодня не доставляется.
`transaction.created`	Транзакция создана и предварительно оценена.
`transaction.status.updated`	Изменился статус транзакции.
`travel_rule.status.updated`	Статус обмена по Travel Rule изменился.
`workflow.compliance_changed`	Статус комплаенса опубликованного сценария изменился.
`transaction_rule_suggestions.created`	В результате запуска формирования предложений по правилам предложены новые изменения в правилах.

Семейства событий Investigator (investigator.*) и Authentication (auth.*) также принимаются; полный список см. в разделе Webhooks. Подробные описания событий и типовые наборы подписок см. в руководстве по созданию адреса назначения.

Авторизации

x-api-key

string

header

обязательно

API-ключ вашего приложения из раздела «Разработчикам» -> «API-ключи» в Business Console. Основной ключ имеет полный доступ. Именованный ключ может иметь ограниченную область действия: без доступа, чтение или запись для каждого ресурса, ограничение определенными сценариями или одобренными сессиями, списком IP-адресов и сроком действия. 401 означает, что ключ неверен, отозван или его срок действия истек; 403 означает, что ключ не был передан, у ключа нет доступа к этому ресурсу или действию, либо запрос поступил с адреса вне его списка IP-адресов; 404 на маршруте сессии означает, что сессия не входит в сценарии или статусы ключа. Ключ без доступа к медиа получает URL изображений, видео и PDF как null, а ключ без прав на запись сессий получает ссылки на сессии и токены как null. См. https://docs.didit.me/console/api-keys.

Параметры пути

destination_uuid

string<uuid>

обязательно

UUID обновляемого адреса назначения webhook.

Тело

application/json

label

string

Новое понятное пользователю имя.

url

string<uri>

Новый целевой URL. Должен быть уникальным в рамках приложения.

enabled

boolean

Установите значение false, чтобы приостановить доставку на этот адрес назначения без его удаления.

webhook_version

enum<string>

Новая версия схемы payload для будущих доставок.

Доступные опции:

v1,

v2,

v3

subscribed_events

enum<string>[]

Фильтр событий для этого адреса назначения webhook. Didit доставляет только те webhook, чей тип события точно совпадает с одним из этих значений — подписка по маске отсутствует. При отправке список должен содержать как минимум одно допустимое событие (явный пустой массив [] отклоняется с кодом 400); адрес назначения с пустым списком (поле пропущено при создании) ничего не получает. При обновлении список заменяется целиком, а не объединяется.

Minimum array length: 1

Поддерживаемое имя события webhook. Используйте именно эти строки в subscribed_events; неподдерживаемые значения отклоняются.

Доступные опции:

status.updated,

data.updated,

user.status.updated,

user.data.updated,

business.status.updated,

business.data.updated,

activity.created,

transaction.created,

transaction.status.updated,

travel_rule.status.updated,

workflow.compliance_changed,

transaction_rule_suggestions.created,

auth.signup,

auth.login,

auth.login_failed,

auth.password_reset_requested,

auth.password_reset_completed,

auth.mfa_changed,

auth.new_device,

auth.account_locked,

investigator.report.ready,

investigator.decision.automated,

investigator.decision.overridden,

investigator.decision.contested,

investigator.question.raised,

investigator.automation.paused,

investigator.rfi.answered,

investigator.rfi.overdue,

investigator.drift.detected,

investigator.sla.breached,

investigator.qa.failed,

investigator.external.report.ready

Пример:

["status.updated", "data.updated"]

Ответ

Обновлённый адрес назначения webhook. Тело имеет ту же структуру, что и GET /v3/webhook/destinations/{destination_uuid}/.

uuid

string<uuid>

label

string

url

string<uri>

enabled

boolean

webhook_version

enum<string>

Доступные опции:

v1,

v2,

v3

secret_shared_key

string

secret_last4

string

Последние четыре символа текущего секрета подписи адреса назначения, позволяющие различать секреты. Недостаточно для проверки подписи.

previous_secret_expires_at

string<date-time> | null

Устанавливается на 24 часа после ротации секрета подписи адреса назначения в Business Console. До истечения этого времени каждая доставка на адрес назначения также содержит X-Signature-Previous, X-Signature-V2-Previous и X-Signature-Simple-Previous, созданные с заменённым секретом (см. Проверка подписи). null, если за последние 24 часа ротация не проводилась.

subscribed_events

enum<string>[]

Minimum array length: 1

Доступные опции:

status.updated,

data.updated,

user.status.updated,

user.data.updated,

business.status.updated,

business.data.updated,

activity.created,

transaction.created,

transaction.status.updated,

travel_rule.status.updated,

workflow.compliance_changed,

transaction_rule_suggestions.created,

auth.signup,

auth.login,

auth.login_failed,

auth.password_reset_requested,

auth.password_reset_completed,

auth.mfa_changed,

auth.new_device,

auth.account_locked,

investigator.report.ready,

investigator.decision.automated,

investigator.decision.overridden,

investigator.decision.contested,

investigator.question.raised,

investigator.automation.paused,

investigator.rfi.answered,

investigator.rfi.overdue,

investigator.drift.detected,

investigator.sla.breached,

investigator.qa.failed,

investigator.external.report.ready

Пример:

["status.updated", "data.updated"]

created_by_email

string | null

Электронная почта участника Business Console, создавшего адрес назначения. null для адреса назначения, созданного с помощью API-ключа.

created_by_name

string | null

Имя участника Business Console, создавшего адрес назначения. null для адреса назначения, созданного с помощью API-ключа.

created_at

string<date-time>

updated_at

string<date-time>

health_status

enum<string>

Состояние доставки. failing: 3 или более последовательных событий завершились неудачей при первой попытке доставки с момента последнего успешного ответа адреса назначения (см. failing_streak). degraded: не failing, но за последние 24 часа произошла неудачная попытка доставки, и ни одна последующая попытка пока не доставила это событие; повторная попытка или повторная отправка, которая доставит его, сбрасывает этот статус. healthy: ни то, ни другое. Не зависит от enabled. Неудачной считается попытка, получившая ответ HTTP 400 или выше, либо оставшаяся вовсе без ответа.

Доступные опции:

healthy,

degraded,

failing

failing_streak

integer

Количество последовательных событий, первая попытка доставки которых завершилась неудачно с момента последнего успешного ответа адреса назначения за последние 30 дней. Повторные попытки не учитываются, и любая успешная попытка, включая повторную попытку или повторную отправку, прерывает серию. Значение равно 0, если с момента последнего успеха не было ни одного сбоя.

failing_since

string<date-time> | null

Когда была совершена первая неудачная попытка из текущей серии ошибок failing_streak. null, если failing_streak равен 0.

last_success_at

string<date-time> | null

Когда адрес назначения в последний раз ответил на доставку с HTTP-статусом ниже 400 за последние 30 дней. null, если ответов в этот период не было.

environment

enum<string>

Среда приложения, которому принадлежит адрес назначения.

Доступные опции:

live,

sandbox

summary

object

Метрики доставки за последние metrics_window_days (30) дней. last_delivery_at представляет собой самую последнюю попытку, когда бы она ни выполнялась.

Show child attributes

Последнее изменение 7 ноября 2026 г.

​Обновление subscribed_events

Авторизации

Параметры пути

Тело

Ответ

Обновление `subscribed_events`