Pular para o conteúdo principal
GET
curl

Status do destino

health_status resume como um destino tem respondido às suas entregas. Uma tentativa com falha é aquela à qual o destino respondeu com HTTP 400 ou superior, ou não respondeu (tempo esgotado, conexão recusada ou endereço bloqueado). As novas tentativas não aumentam failing_streak, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. health_status é independente de enabled. As métricas de entrega e daily_points abrangem os últimos 30 dias (metrics_window_days). daily_points sempre tem 30 entradas, uma por dia UTC, da mais antiga para a mais recente.

Relacionados

Autorizações

x-api-key
string
header
obrigatório

Chave de API da sua aplicação, em Developers -> API keys no Business Console. A chave principal tem acesso total. Uma chave nomeada pode ter escopo restrito: nenhum acesso, leitura ou escrita por recurso, limitada a alguns fluxos ou a sessões aprovadas, a uma lista de endereços IP e a uma data de validade. 401 significa que a chave está errada, revogada ou expirada; 403 significa que nenhuma chave foi enviada, que a chave não tem acesso a este recurso ou ação, ou que a requisição veio de um endereço fora da sua lista de IPs; 404 em uma rota de sessão significa que a sessão está fora dos fluxos ou status da chave. Uma chave sem acesso a mídia recebe URLs de imagem, vídeo e PDF como null, e uma chave sem permissão de escrita em sessões recebe links e tokens de sessão como null. Consulte https://docs.didit.me/console/api-keys.

Resposta

Lista de destinos de webhook (sem paginação, os mais antigos primeiro).

uuid
string<uuid>

Identificador estável do destino; use como {destination_uuid} para atualizar ou excluir.

label
string

Nome legível exibido no Console.

url
string<uri>

URL de destino que recebe requisições POST com o payload do webhook.

enabled
boolean

Quando false, a Didit ignora silenciosamente a entrega para este destino.

webhook_version
enum<string>

Versão do esquema de payload enviada a este destino. v3 é o formato atual/recomendado.

Opções disponíveis:
v1,
v2,
v3
subscribed_events
enum<string>[]

Filtro de eventos deste destino do webhook. A Didit entrega apenas webhooks cujo tipo de evento corresponde exatamente a um destes valores; não existe assinatura curinga. Quando enviada, a lista deve conter pelo menos um evento válido (um [] explícito é rejeitado com 400); um destino cuja lista está vazia (campo omitido na criação) não recebe nada. Na atualização, a lista é substituída por inteiro, nunca mesclada.

Minimum array length: 1

Nome de evento de webhook compatível. Use exatamente estas strings em subscribed_events; valores não compatíveis são rejeitados.

Opções disponíveis:
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
Exemplo:
subscribed_events_count
integer

Tamanho de subscribed_events armazenado em cache, útil para renderizar a interface.

deliveries_count
integer

Tentativas de entrega (incluindo novas tentativas) feitas para este destino nos últimos 30 dias.

failed_deliveries_count
integer

Tentativas de entrega nos últimos 30 dias às quais o destino respondeu com HTTP 400 ou superior, ou não respondeu (tempo esgotado, conexão recusada ou endereço bloqueado).

average_response_time_ms
integer | null

Tempo médio de resposta em milissegundos nos últimos 30 dias, arredondado para um número inteiro. null quando não houve entregas nesse período.

error_rate_percentage
integer

round(failed_deliveries_count / deliveries_count * 100) nos últimos 30 dias; 0 quando não há entregas.

last_delivery_at
string<date-time> | null

Data e hora da tentativa de entrega mais recente (com sucesso ou falha). null se nunca foi entregue.

metrics_window_days
integer

Duração, em dias, da janela coberta por deliveries_count, failed_deliveries_count, average_response_time_ms, error_rate_percentage e daily_points. Sempre 30.

health_status
enum<string>

Saúde das entregas. failing: 3 ou mais eventos consecutivos falharam na primeira tentativa de entrega desde a última vez que o destino respondeu com sucesso (consulte failing_streak). degraded: não está em falha, mas uma tentativa de entrega falhou nas últimas 24 horas e nenhuma tentativa posterior entregou esse evento; uma nova tentativa ou um reenvio que o entregue remove esse estado. healthy: nenhum dos dois. Independe de enabled. Uma tentativa com falha é aquela respondida com HTTP 400 ou superior, ou que não recebeu resposta.

Opções disponíveis:
healthy,
degraded,
failing
failing_streak
integer

Quantos eventos consecutivos falharam na primeira tentativa de entrega desde a última resposta bem-sucedida do destino, nos últimos 30 dias. Novas tentativas não são contadas, e qualquer tentativa bem-sucedida, incluindo uma nova tentativa ou um reenvio, encerra a sequência. 0 quando nenhum evento falhou desde o último sucesso.

failing_since
string<date-time> | null

Quando foi feita a primeira tentativa com falha do failing_streak atual. null quando failing_streak é 0.

last_success_at
string<date-time> | null

Quando o destino respondeu pela última vez a uma entrega com um status HTTP abaixo de 400, nos últimos 30 dias. null se isso não ocorreu nesse período.

environment
enum<string>

Ambiente da aplicação proprietária do destino.

Opções disponíveis:
live,
sandbox
daily_points
object[]

Uma entrada por dia UTC dos últimos 30 dias, da mais antiga para a mais recente, incluindo dias sem entregas. Conta todas as tentativas, incluindo as novas tentativas.

secret_last4
string

Últimos quatro caracteres do segredo de assinatura atual do destino, para que você possa distinguir os segredos. Não é suficiente para verificar uma assinatura.

created_by_email
string | null

E-mail do membro do Business Console que criou o destino. null para um destino criado com uma chave de API.

created_by_name
string | null

Nome do membro do Business Console que criou o destino. null para um destino criado com uma chave de API.

created_at
string<date-time>
updated_at
string<date-time>
Última modificação em 1 de novembro de 2026