Перейти к основному содержанию
GET
curl

Состояние адреса назначения

health_status показывает, как адрес назначения отвечал на доставку событий. Неудачной считается попытка, на которую адрес назначения ответил HTTP-кодом 400 или выше либо вовсе не ответил (тайм-аут, отказ в соединении или заблокированный адрес). Повторные попытки не увеличивают failing_streak, а любая успешная попытка, включая повторную попытку или повторную отправку, завершает серию. health_status не зависит от enabled. Метрики доставки и daily_points охватывают последние 30 дней (metrics_window_days). daily_points всегда содержит 30 записей, по одной на каждый день UTC, от самой старой к самой новой.

Связанные материалы

Авторизации

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.

Ответ

Список адресов назначения webhook (без пагинации, сначала самые старые).

uuid
string<uuid>

Постоянный идентификатор назначения; используйте как {destination_uuid} для обновления или удаления.

label
string

Понятное имя, отображаемое в Console.

url
string<uri>

URL адреса назначения, принимающий POST-запросы с payload webhook.

enabled
boolean

Если false, Didit без уведомления пропускает доставку на этот адрес назначения.

webhook_version
enum<string>

Версия схемы payload, отправляемая по этому адресу назначения. v3 является текущим и рекомендуемым форматом.

Доступные опции:
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
Пример:
subscribed_events_count
integer

Кэшированная длина subscribed_events, полезна для отрисовки в UI.

deliveries_count
integer

Попытки доставки (включая повторные попытки), выполненные на этот адрес назначения за последние 30 дней.

failed_deliveries_count
integer

Попытки доставки за последние 30 дней, на которые адрес назначения ответил кодом HTTP 400 или выше либо не ответил (тайм-аут, отклонённое соединение или заблокированный адрес).

average_response_time_ms
integer | null

Среднее время ответа в миллисекундах за последние 30 дней, округлённое до целого числа. null, если за этот период доставок не было.

error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) за последние 30 дней; 0, если доставок не было.

last_delivery_at
string<date-time> | null

Временная метка последней попытки доставки (успешной или неудачной). null, если доставка не выполнялась.

metrics_window_days
integer

Длина окна в днях, охватываемого полями deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage и daily_points. Всегда 30.

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
daily_points
object[]

Одна запись на каждый день по UTC за последние 30 дней, начиная с самых старых, включая дни без доставок. Учитывает каждую попытку, включая повторные попытки.

secret_last4
string

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

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>
Последнее изменение 7 ноября 2026 г.