跳转到主要内容
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 密钥，可在 Business Console 的“开发者 -> API 密钥”中获取。主密钥拥有完整访问权限。指定名称的密钥可设置作用域：针对每个资源设为无权限、只读或读写，限定于特定工作流或已通过的会话、限定于 IP 地址列表，以及设置到期日期。401 表示密钥错误、已撤销或已过期；403 表示未发送密钥、密钥无权访问该资源或操作，或请求来自其 IP 列表之外的地址；在会话路由上返回 404 表示该会话不在该密钥允许的工作流或状态范围内。没有媒体访问权限的密钥获取到的图片、视频和 PDF URL 将为 null；没有会话写入权限的密钥获取到的会话链接和 token 将为 null。请参阅 https://docs.didit.me/console/api-keys。

响应

Webhook 目标列表（未分页，最早的优先）。

​
uuid
string<uuid>

目标的稳定标识符；在更新/删除时用作 {destination_uuid}。

​
label
string

在 Console 中显示的便于人类阅读的名称。

​
url
string<uri>

接收包含 Webhook payload 的 POST 请求的目标 URL。

​
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

过去 30 天内的 round(failed_deliveries_count / deliveries_count * 100)；无投递记录时为 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 中第一次失败尝试的时间。当 failing_streak 为 0 时为 null。

​
last_success_at
string<date-time> | null

在过去 30 天内，目标上次以低于 400 的 HTTP 状态响应投递的时间。如果在此时间窗口内没有以低于 400 的 HTTP 状态响应，则为 null。

​
environment
enum<string>

拥有该目标的应用的环境。

可用选项:
live,
sandbox
​
daily_points
object[]

过去 30 天内每个 UTC 天对应一个条目，按时间从早到晚排列，包含没有投递的日期。统计每一次尝试，包括重试在内。

​
secret_last4
string

目标当前签名密钥的最后四位字符，以便您区分不同的密钥。不足以用于验证签名。

​
created_by_email
string | null

创建该目标的 Business Console 成员的邮箱。通过 API 密钥创建的目标为 null。

​
created_by_name
string | null

创建该目标的 Business Console 成员姓名。使用 API 密钥创建的目标为 null。

​
created_at
string<date-time>
​
updated_at
string<date-time>
最后修改于 2026年11月7日