> For the complete documentation index, see [llms.txt](https://docs.compliance.phalcon.blocksec.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.compliance.phalcon.blocksec.com/zh/manual/notification-channels/webhook-format.md).

# Webhook 格式

## Webhook 消息

<table><thead><tr><th width="192.21875">字段</th><th width="125.03125">类型</th><th>描述</th></tr></thead><tbody><tr><td>type</td><td>Integer</td><td><p>Webhook 接收到的消息类型：</p><ol><li>notification（Risk Engine 告警）</li><li>monitorEvent（监控事件）</li></ol></td></tr><tr><td>typeDescription</td><td>String</td><td><p>变量的有效值范围：</p><p>["notification", "monitorEvent"]</p></td></tr><tr><td>data</td><td>Object</td><td>消息的具体细节由 type 的值决定。</td></tr></tbody></table>

### 通知数据

<table><thead><tr><th width="198.01953125">字段</th><th width="133.109375">类型</th><th>描述</th></tr></thead><tbody><tr><td>triggeringId</td><td>String</td><td>触发通知的告警 ID。</td></tr><tr><td>riskEngineId</td><td>String</td><td>触发通知的风险引擎 ID。</td></tr><tr><td>riskEngineName</td><td>String</td><td>触发通知的风险引擎名称。</td></tr><tr><td>targetType</td><td>Integer</td><td><p>1: 地址</p><p>2: 交易</p></td></tr><tr><td>targetTypeDescription</td><td>String</td><td><p>变量的有效值范围：</p><p>["address", "transaction"]</p></td></tr><tr><td>chainId</td><td>Integer</td><td>不同区块链网络的链 ID。</td></tr><tr><td>targetIdentifiter</td><td>String</td><td><p>如果 targetType 为 1，则为地址</p><p>如果 targetType 为 2，则为交易哈希</p></td></tr><tr><td>riskType</td><td>Integer</td><td><p>与触发通知的风险引擎相关联的风险类型。</p><p>1: exposure</p><p>2: behavior</p></td></tr><tr><td>riskTypeDescription</td><td>String</td><td><p>变量的有效值范围：</p><p>["exposure", "behavior"]</p></td></tr><tr><td>riskLevel</td><td>Integer</td><td><p>与触发通知的风险引擎相关联的用户定义风险等级。</p><ol><li>critical</li><li>high</li><li>medium</li><li>low</li><li>informational</li></ol></td></tr><tr><td>riskLevelDescription</td><td>String</td><td><p>变量的有效值范围：</p><p>["critical", "high", "medium", "low", "informational"]</p></td></tr><tr><td>timestamp</td><td>String</td><td>告警时间戳，采用 ISO 8601 格式。</td></tr><tr><td>type</td><td>Integer</td><td><p>详细通知数据的类型</p><p>地址类型：</p><p>1: 实体风险数据</p><p>2: 交互风险数据</p><p>3: 大额转账数据</p><p>4: 高频数据</p><p>5: 过渡地址数据</p><p>6: 黑名单交互数据</p><p>交易类型：</p><p>7: 参与者风险数据</p><p>8: 交互风险数据</p><p>9: 大额转账数据</p><p>10: 快速过渡数据</p><p>11: 黑名单交互数据</p></td></tr><tr><td>data</td><td>Array[Object]</td><td><p>通知的详细信息列表由风险引擎类型决定。</p><p>有关更多详情，请参阅以下部分。</p></td></tr></tbody></table>

#### 1. 地址 - 实体风险数据

<table><thead><tr><th width="203.15234375">字段</th><th width="133.04296875">类型</th><th>描述</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td><p>根据预配置规则匹配的风险指标。</p><p>1: 制裁</p><p>2: 攻击</p><p>3: 诈骗</p><p>4: 勒索软件</p><p>5: 儿童虐待材料</p><p>6: 洗钱</p><p>7: 混币</p><p>8: 暗网市场</p><p>9: 暗网业务</p><p>10: 被阻止</p><p>11: 赌博</p><p>12: 无 KYC 交易所<br>13. 恐怖融资<br>14. FATF 高风险司法管辖区<br>15. FATF 灰名单司法管辖区<br>16. 人口贩运<br>17. 毒品贩运</p></td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td><p>变量的有效值范围：</p><p>["Sanctioned", "Attack", "Scam", "Ransomware", "Child Abuse Material", "Laundering", "Mixing", "Dark Market", "Darkweb Business", "Blocked", "Gambling", "No KYC Exchange", "Terrorist Financing", "FATF High Risk Jurisdiction", "FATF Grey List Jurisdiction", "Human Trafficking", "Drug Trafficking"]</p></td></tr><tr><td>detail</td><td>Array[String]</td><td>补充信息</td></tr></tbody></table>

#### 2. 地址 - 交互风险数据

<table><thead><tr><th width="213.07421875">字段</th><th width="133.50390625">类型</th><th>描述</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>direction</td><td>Integer</td><td>转账方向：<br>• 1 : 入账（收到资金）<br>• 2 : 出账（发送资金）</td></tr><tr><td>hop</td><td>Integer</td><td>与风险实体的分离度：<br>• 1 : 直接交互<br>• 2+ : 间接交互（跳数）</td></tr><tr><td>exposureValue</td><td>String</td><td>暴露资金的绝对值（以美元计）</td></tr><tr><td>exposurePercent</td><td>String</td><td>被风险"污染"的总交易量的百分比</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>此交互的详情，包括每个参与地址及其在此交互中的具体风险暴露信息的列表。</td></tr><tr><td>>address</td><td>String</td><td>具有风险指标的地址。</td></tr><tr><td>>label</td><td>String</td><td>地址的标签。</td></tr><tr><td>>detail</td><td>String</td><td>详细的风险信息。</td></tr><tr><td>>hop</td><td>Integer</td><td>到筛查地址的最小跳数。</td></tr><tr><td>>exposureValue</td><td>String</td><td>贡献的风险暴露值，以美元计。</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>贡献的风险暴露百分比。</td></tr></tbody></table>

#### 3. 地址 - 大额转账数据

<table><thead><tr><th width="205.31640625">字段</th><th width="97.8984375">类型</th><th>描述</th></tr></thead><tbody><tr><td>transaction</td><td>String</td><td>交易哈希</td></tr><tr><td>usdValue</td><td>String</td><td>转账价值，以美元计</td></tr><tr><td>direction</td><td>Integer</td><td>转账方向：<br>• 1 : 入账（收到资金）<br>• 2 : 出账（发送资金）</td></tr><tr><td>timestamp</td><td>String</td><td>交易时间戳，采用 ISO 8601 格式</td></tr><tr><td>token</td><td>String</td><td>代币合约地址</td></tr><tr><td>tokenSymbol</td><td>String</td><td>代币符号</td></tr><tr><td>tokenAmount</td><td>String</td><td>代币数量</td></tr></tbody></table>

#### 4. 地址 - 高频数据

<table><thead><tr><th width="201.19140625">字段</th><th width="142.28515625">类型</th><th>描述</th></tr></thead><tbody><tr><td>transactionCount</td><td>Integer</td><td>观察期内的交易总数</td></tr><tr><td>duration</td><td>Integer</td><td>四舍五入到最近的分钟</td></tr><tr><td>transactionList</td><td>Array[Object]</td><td>单个交易详情的数组</td></tr><tr><td>>transactionItem</td><td>Object</td><td>交易项目格式：与**大额转账数据模式**相同</td></tr></tbody></table>

#### 5. 地址 - 过渡地址数据

<table><thead><tr><th width="179.84765625">字段</th><th width="118.41796875">类型</th><th>描述</th></tr></thead><tbody><tr><td>inTransaction</td><td>String</td><td>入账交易哈希</td></tr><tr><td>inTimestamp</td><td>String</td><td>入账交易时间戳，采用 ISO 8601 格式</td></tr><tr><td>inUsdValue</td><td>String</td><td>入账转账价值（美元）</td></tr><tr><td>outTransaction</td><td>String</td><td>出账交易哈希</td></tr><tr><td>outTimestamp</td><td>String</td><td>出账交易时间戳，采用 ISO 8601 格式</td></tr><tr><td>outUsdValue</td><td>String</td><td>出账转账价值（美元）</td></tr><tr><td>transitPercent</td><td>String</td><td>过渡资金百分比</td></tr></tbody></table>

#### 6. 地址 - 黑名单交互数据

<table><thead><tr><th width="213.07421875">字段</th><th width="133.50390625">类型</th><th>描述</th></tr></thead><tbody><tr><td>direction</td><td>Integer</td><td>转账方向：<br>• 1 : 入账（收到资金）<br>• 2 : 出账（发送资金）</td></tr><tr><td>hop</td><td>Integer</td><td>与风险实体的分离度：<br>• 1 : 直接交互<br>• 2+ : 间接交互（跳数）</td></tr><tr><td>exposureValue</td><td>String</td><td>暴露资金的绝对值（以美元计）</td></tr><tr><td>exposurePercent</td><td>String</td><td>被风险"污染"的总交易量的百分比</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>此交互的详情，包括每个参与地址及其在此交互中的具体风险暴露信息的列表。</td></tr><tr><td>>address</td><td>String</td><td>具有风险指标的地址。</td></tr><tr><td>>label</td><td>String</td><td>地址的标签。</td></tr><tr><td>>hop</td><td>Integer</td><td>到筛查地址的最小跳数。</td></tr><tr><td>>exposureValue</td><td>String</td><td>贡献的风险暴露值，以美元计。</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>贡献的风险暴露百分比。</td></tr></tbody></table>

#### 7. 交易 - 参与者风险数据

<table><thead><tr><th width="158.515625">字段</th><th width="143.9140625">类型</th><th>描述</th></tr></thead><tbody><tr><td>address</td><td>String</td><td>检测到风险指标的参与者地址。</td></tr><tr><td>riskIndicator</td><td>Integer</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>detail</td><td>Array[String]</td><td>补充信息</td></tr></tbody></table>

#### 8. 交易 - 交互风险数据

<table><thead><tr><th width="213.07421875">字段</th><th width="133.50390625">类型</th><th>描述</th></tr></thead><tbody><tr><td>riskIndicator</td><td>Integer</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>riskIndicatorDescription</td><td>String</td><td>使用与***实体风险数据***相同的值和定义</td></tr><tr><td>direction</td><td>Integer</td><td>转账方向：<br>• 1 : 入账（收到资金）<br>• 2 : 出账（发送资金）</td></tr><tr><td>hop</td><td>Integer</td><td>与风险实体的分离度：<br>• 1 : 直接交互<br>• 2+ : 间接交互（跳数）</td></tr><tr><td>exposureValue</td><td>String</td><td>暴露资金的绝对值（以美元计）</td></tr><tr><td>exposurePercent</td><td>String</td><td>被风险"污染"的总交易量的百分比</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>此交互的详情，包括每个参与地址及其在此交互中的具体风险暴露信息的列表。</td></tr><tr><td>>address</td><td>String</td><td>具有风险指标的地址。</td></tr><tr><td>>label</td><td>String</td><td>地址的标签。</td></tr><tr><td>>detail</td><td>String</td><td>详细的风险信息。</td></tr><tr><td>>hop</td><td>Integer</td><td>到筛查地址的最小跳数。</td></tr><tr><td>>exposureValue</td><td>String</td><td>贡献的风险暴露值，以美元计。</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>贡献的风险暴露百分比。</td></tr></tbody></table>

#### 9. 交易 - 大额转账数据

<table><thead><tr><th width="224.0390625">字段</th><th width="202.22265625">类型</th><th>描述</th></tr></thead><tbody><tr><td>transaction</td><td>String</td><td>交易哈希</td></tr><tr><td>usdValue</td><td>String</td><td>转账价值，以美元计</td></tr><tr><td>fromAddress</td><td>String</td><td>发送方地址</td></tr><tr><td>toAddress</td><td>String</td><td>接收方地址</td></tr><tr><td>timestamp</td><td>String</td><td>交易时间戳，采用 ISO 8601 格式</td></tr><tr><td>token</td><td>String</td><td>代币合约地址</td></tr><tr><td>tokenSymbol</td><td>String</td><td>代币符号</td></tr><tr><td>tokenAmount</td><td>String</td><td>此次转账中的代币数量</td></tr></tbody></table>

#### 10. 交易 - 快速过渡数据

<table><thead><tr><th width="223.77734375">字段</th><th width="201">类型</th><th>描述</th></tr></thead><tbody><tr><td>proceedTransaction</td><td>Object</td><td>对象格式：与大额转账数据模式相同</td></tr><tr><td>ScreenedTransaction</td><td>Object</td><td>对象格式：与大额转账数据模式相同</td></tr></tbody></table>

#### 11. 交易 - 黑名单交互数据

<table><thead><tr><th width="213.07421875">字段</th><th width="133.50390625">类型</th><th>描述</th></tr></thead><tbody><tr><td>direction</td><td>Integer</td><td>转账方向：<br>• 1 : 入账（收到资金）<br>• 2 : 出账（发送资金）</td></tr><tr><td>hop</td><td>Integer</td><td>与风险实体的分离度：<br>• 1 : 直接交互<br>• 2+ : 间接交互（跳数）</td></tr><tr><td>exposureValue</td><td>String</td><td>暴露资金的绝对值（以美元计）</td></tr><tr><td>exposurePercent</td><td>String</td><td>被风险"污染"的总交易量的百分比</td></tr><tr><td>contributions</td><td>Array[Object]</td><td>此交互的详情，包括每个参与地址及其在此交互中的具体风险暴露信息的列表。</td></tr><tr><td>>address</td><td>String</td><td>具有风险指标的地址。</td></tr><tr><td>>label</td><td>String</td><td>地址的标签。</td></tr><tr><td>>hop</td><td>Integer</td><td>到筛查地址的最小跳数。</td></tr><tr><td>>exposureValue</td><td>String</td><td>贡献的风险暴露值，以美元计。</td></tr><tr><td>>exposurePercent</td><td>Number</td><td>贡献的风险暴露百分比。</td></tr></tbody></table>

***

## 监控事件数据

当通知渠道启用**监控事件**时，监控事件以 `type: 2`（`monitorEvent`）消息形式交付。仅推送风险相关事件（不包括监控开始/停止等生命周期事件）。交付受您的[通知触发设置](/zh/manual/monitor.md#setting-up-notifications)控制。

### 公共字段

所有监控事件消息在 `data` 对象中共享这些字段：

<table><thead><tr><th width="210">字段</th><th width="110">类型</th><th>描述</th></tr></thead><tbody><tr><td>eventType</td><td>Integer</td><td>事件类型：4（risk_level_increased）、5（risk_level_decreased）、6（alert_triggered）、7（alert_expired）</td></tr><tr><td>eventTypeDescription</td><td>String</td><td>人类可读的事件类型名称</td></tr><tr><td>targetType</td><td>Integer</td><td>1: 地址，2: 交易（目前仅支持地址）</td></tr><tr><td>targetTypeDescription</td><td>String</td><td>"address" 或 "transaction"</td></tr><tr><td>chainId</td><td>Integer</td><td>链 ID</td></tr><tr><td>targetIdentifier</td><td>String</td><td>被监控的地址</td></tr><tr><td>riskLevel</td><td>Integer</td><td>地址的当前总体风险等级（1: critical、2: high、3: medium、4: low）</td></tr><tr><td>riskLevelDescription</td><td>String</td><td>风险等级名称</td></tr><tr><td>timestamp</td><td>String</td><td>事件时间，采用 ISO 8601 格式</td></tr></tbody></table>

### 风险等级提升 / 降低（eventType 4, 5）

当被监控地址的总体风险等级变化时发送。包括以下额外字段：

<table><thead><tr><th width="210">字段</th><th width="110">类型</th><th>描述</th></tr></thead><tbody><tr><td>prevLevel</td><td>Integer</td><td>变化前的风险等级</td></tr><tr><td>prevLevelDescription</td><td>String</td><td>之前的风险等级名称</td></tr><tr><td>newLevel</td><td>Integer</td><td>变化后的风险等级</td></tr><tr><td>newLevelDescription</td><td>String</td><td>新的风险等级名称</td></tr><tr><td>relatedAlerts</td><td>Array</td><td>导致等级变化的告警</td></tr></tbody></table>

`relatedAlerts` 中的每个对象：

<table><thead><tr><th width="210">字段</th><th width="110">类型</th><th>描述</th></tr></thead><tbody><tr><td>alertId</td><td>String</td><td>告警 ID</td></tr><tr><td>riskEngineId</td><td>String</td><td>风险引擎 ID</td></tr><tr><td>riskEngineName</td><td>String</td><td>风险引擎名称</td></tr><tr><td>riskLevel</td><td>Integer</td><td>告警风险等级</td></tr><tr><td>riskLevelDescription</td><td>String</td><td>告警风险等级名称</td></tr><tr><td>action</td><td>String</td><td>"triggered" 或 "expired"</td></tr></tbody></table>

### 告警触发 / 过期（eventType 6, 7）

当告警被触发或过期但未导致风险等级变化时发送。如果导致等级变化，则改为包含在风险等级提升/降低消息的 `relatedAlerts` 中。

这些事件包括一个 `alerts` 数组，每个对象有以下字段：

<table><thead><tr><th width="230">字段</th><th width="110">类型</th><th>描述</th></tr></thead><tbody><tr><td>alertId</td><td>String</td><td>告警 ID</td></tr><tr><td>riskEngineId</td><td>String</td><td>风险引擎 ID</td></tr><tr><td>riskEngineName</td><td>String</td><td>风险引擎名称</td></tr><tr><td>alertRiskLevel</td><td>Integer</td><td>告警自身的风险等级（与地址的总体风险等级不同）</td></tr><tr><td>alertRiskLevelDescription</td><td>String</td><td>告警风险等级名称</td></tr><tr><td>description</td><td>String</td><td>告警描述</td></tr></tbody></table>