Saltar al contenido principal
GET
curl

Estado del destino

health_status resume cómo ha respondido un destino a sus entregas. Un intento fallido es aquel ante el que el destino respondió con HTTP 400 o superior, o ante el que no respondió en absoluto (tiempo de espera agotado, conexión rechazada o dirección bloqueada). Los reintentos no suman a failing_streak, y cualquier intento exitoso, incluido un reintento o un reenvío, pone fin a la racha. health_status es independiente de enabled. Las métricas de entrega y daily_points cubren los últimos 30 días (metrics_window_days). daily_points siempre tiene 30 entradas, una por día UTC, de la más antigua a la más reciente.

Contenido relacionado

Autorizaciones

x-api-key
string
header
requerido

La clave de API de tu aplicación, que encontrarás en Developers -> API keys en la Business Console. La clave principal tiene acceso completo. Una clave con nombre puede tener un alcance limitado: ninguno, lectura o escritura por recurso, limitada a algunos flujos o a sesiones aprobadas, a una lista de direcciones IP y a una fecha de caducidad. 401 significa que la clave es incorrecta, se revocó o expiró; 403 significa que no se envió ninguna clave, que la clave no tiene acceso a este recurso o acción, o que la solicitud provino de una dirección fuera de su lista de IP; 404 en una ruta de sesión significa que la sesión está fuera de los flujos o estados de la clave. Una clave sin acceso a contenido multimedia recibe las URL de imágenes, videos y PDF como null, y una clave sin permiso de escritura en sesiones recibe los enlaces y tokens de sesión como null. Consulta https://docs.didit.me/console/api-keys.

Respuesta

Lista de destinos de webhook (sin paginar, del más antiguo al más reciente).

uuid
string<uuid>

Identificador estable del destino; úsalo como {destination_uuid} para actualizarlo o eliminarlo.

label
string

Nombre legible que se muestra en la Console.

url
string<uri>

URL de destino que recibe solicitudes POST con el payload del webhook.

enabled
boolean

Cuando es false, Didit omite sin avisar la entrega a este destino.

webhook_version
enum<string>

Versión del esquema del payload que se envía a este destino. v3 es el formato actual y recomendado.

Opciones disponibles:
v1,
v2,
v3
subscribed_events
enum<string>[]

Filtro de eventos de este destino de webhook. Didit entrega solo los webhooks cuyo tipo de evento coincide exactamente con uno de estos valores: no existe una suscripción comodín. Si se envía, la lista debe contener al menos un evento válido (un [] explícito se rechaza con 400). Un destino con la lista vacía (campo omitido al crearlo) no recibe nada. Al actualizar, la lista se reemplaza por completo y nunca se combina.

Minimum array length: 1

Nombre de evento de webhook admitido. Usa exactamente estas cadenas en subscribed_events; los valores no admitidos se rechazan.

Opciones disponibles:
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
Ejemplo:
subscribed_events_count
integer

Longitud de subscribed_events almacenada en caché, útil para renderizar la interfaz.

deliveries_count
integer

Intentos de entrega (reintentos incluidos) realizados a este destino en los últimos 30 días.

failed_deliveries_count
integer

Intentos de entrega de los últimos 30 días a los que el destino respondió con HTTP 400 o superior, o no respondió (tiempo de espera agotado, conexión rechazada o dirección bloqueada).

average_response_time_ms
integer | null

Tiempo de respuesta promedio en milisegundos de los últimos 30 días, redondeado a un entero. null cuando no hubo entregas en ese periodo.

error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) en los últimos 30 días; 0 cuando no hay entregas.

last_delivery_at
string<date-time> | null

Marca de tiempo del intento de entrega más reciente (correcto o fallido). null si nunca se entregó.

metrics_window_days
integer

Duración en días de la ventana que cubren deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage y daily_points. Siempre 30.

health_status
enum<string>

Estado de las entregas. failing: 3 o más eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente (consulta failing_streak). degraded: el destino no está fallando, pero un intento de entrega falló en las últimas 24 horas y ningún intento posterior ha entregado ese evento; un reintento o un reenvío que lo entregue elimina este estado. healthy: ninguno de los dos casos anteriores. Es independiente de enabled. Un intento fallido es aquel que recibe una respuesta HTTP 400 o superior, o que no recibe ninguna respuesta.

Opciones disponibles:
healthy,
degraded,
failing
failing_streak
integer

Cuántos eventos consecutivos fallaron en su primer intento de entrega desde la última vez que el destino respondió correctamente, dentro de los últimos 30 días. Los reintentos no se cuentan, y cualquier intento correcto, incluido un reintento o un reenvío, pone fin a la racha. 0 cuando ningún evento ha fallado desde el último éxito.

failing_since
string<date-time> | null

Cuándo se realizó el primer intento fallido de la failing_streak actual. null cuando failing_streak es 0.

last_success_at
string<date-time> | null

Cuándo el destino respondió por última vez a una entrega con un estado HTTP inferior a 400, dentro de los últimos 30 días. null si no lo ha hecho en ese periodo.

environment
enum<string>

Entorno de la aplicación a la que pertenece el destino.

Opciones disponibles:
live,
sandbox
daily_points
object[]

Una entrada por día UTC de los últimos 30 días, de la más antigua a la más reciente, incluidos los días sin entregas. Cuenta cada intento, reintentos incluidos.

secret_last4
string

Últimos cuatro caracteres del secreto de firma actual del destino, para que puedas distinguir los secretos. No basta para verificar una firma.

created_by_email
string | null

Correo electrónico del miembro de Business Console que creó el destino. null para un destino creado con una clave de API.

created_by_name
string | null

Nombre del miembro de Business Console que creó el destino. null para un destino creado con una clave de API.

created_at
string<date-time>
updated_at
string<date-time>
Última modificación el 1 de noviembre de 2026