跳转到内容
本站为社区维护的非官方中文翻译,与 Cloudflare, Inc. 无关联。本站不提供账户登录,请勿在任何非官方站点输入您的 Cloudflare 账户信息。官方文档:developers.cloudflare.com

Webhook 载荷结构

最后更新 查看 MarkdownAgent 设置

当您配置通用 Webhook 后,Cloudflare 会为每条通知向您指定的 URL 发送一个 JSON 载荷。本页记录了该载荷的结构。

载荷结构

所有通用 Webhook 通知均遵循以下结构:

{
    "name": "string",
    "text": "string",
    "data": {},
    "ts": 1136214245,
    "account_id": "string",
    "policy_id": "string",
    "policy_name": "string",
    "alert_type": "string",
    "alert_correlation_id": "string",
    "alert_event": "string"
}

字段说明

字段 类型 说明
name 字符串 通知策略的名称。
text 字符串 包含插值的人类可读的通知描述。
data object 告警特定数据,结构因 alert_type 而异。
ts 整数 生成通知时的 Unix 时间戳(UTC 纪元以来的秒数)。
account_id 字符串 触发此 Webhook 的账户 ID。
policy_id 字符串 触发此 Webhook 的通知策略的 UUID。
policy_name 字符串 通知策略的名称。
alert_type 字符串 告警类型的唯一标识符(例如 http_alert_origin_error)。
alert_correlation_id 字符串 将相关告警归组的 UUID。
alert_event 字符串 事件状态,例如 ALERT_STATE_EVENT_START 或 ALERT_STATE_EVENT_END。

载荷示例

以下示例展示了常见告警类型的载荷结构,data 对象因具体告警而异。

DDoS 攻击(第 4 层)

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "advanced_ddos_attack_l4_alert",
    "data": {
        "account_name": "string",
        "account_tag": "string",
        "action": "string",
        "attack_id": "string",
        "attack_vector": "string",
        "dashboard_link": "string",
        "max_rate": "string",
        "megabits_per_second": 0,
        "mitigation": "string",
        "packets_per_second": 0,
        "protocol": "string",
        "rule_description": "string",
        "rule_id": "string",
        "rule_name": "string",
        "ruleset_id": "string",
        "ruleset_override_id": "string",
        "start_time": "2006-01-02T15:04:05Z",
        "target_id": "string",
        "target_ip": "string",
        "target_port": 0
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

DDoS 攻击(第 7 层)

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "advanced_ddos_attack_l7_alert",
    "data": {
        "account_name": "string",
        "account_tag": "string",
        "action": "string",
        "attack_id": "string",
        "attack_type": "string",
        "dashboard_link": "string",
        "max_rate": "string",
        "mitigation": "string",
        "requests_per_second": 0,
        "rule_description": "string",
        "rule_id": "string",
        "rule_link": "string",
        "ruleset_id": "string",
        "ruleset_override_id": "string",
        "start_time": "2006-01-02T15:04:05Z",
        "target_hostname": "string",
        "zone_name": "string",
        "zone_tag": "string"
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

SSL 证书到期

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "dedicated_ssl_certificate_event_type",
    "data": {
        "account_name": "string",
        "account_tag": "string",
        "certificate_id": "string",
        "certificate_pack_id": "string",
        "certificate_status": "string",
        "event_type": "string",
        "hostnames": "string",
        "pack_ca": "string",
        "pack_id": "string",
        "pack_status": "string",
        "pack_validation": "string",
        "zone_name": "string",
        "zone_tag": "string"
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

源站健康检查

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "health_check_status_notification",
    "data": {
        "account_name": "string",
        "account_tag": "string",
        "failing_regions": "string",
        "health_check_id": "string",
        "health_check_name": "string",
        "new_health_status": "string",
        "new_status": "string",
        "old_status": "string",
        "origin_ip": "string",
        "reason": "string",
        "status_change_time": "2006-01-02T15:04:05Z",
        "time_since_last_failure": "string",
        "zone_name": "string",
        "zone_tag": "string"
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

Workers 告警

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "workers_alert",
    "data": {
        "account_name": "string",
        "account_script_count": 0,
        "account_tag": "string",
        "alert_type": "string",
        "current_year": 0,
        "end_date": "string",
        "exceeding_script_count": 0,
        "scripts": [
            {
                "constant_script_id": 0,
                "cpu_time_previous_value": 0,
                "cpu_time_unit": "string",
                "cpu_time_value": 0,
                "data_egress_unit": "string",
                "data_egress_value": 0,
                "duration_previous_value": 0,
                "duration_unit": "string",
                "duration_value": 0,
                "last_modified": "string",
                "request_count_previous_value": 0,
                "request_count_unit": "string",
                "request_count_value": 0,
                "routes": ["string"],
                "script_name": "string",
                "usage_model": 0
            }
        ],
        "start_date": "string",
        "total_data_egress_unit": "string",
        "total_data_egress_value": 0,
        "total_duration_unit": "string",
        "total_duration_value": 0,
        "total_request_count_unit": "string",
        "total_request_count_value": 0
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

Access 证书到期

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "access_custom_certificate_expiration_type",
    "data": {
        "account_name": "string",
        "account_tag": "string",
        "certificate_id": "string",
        "days_til_expiration": 0,
        "hostnames": "string",
        "zone_name": "string",
        "zone_tag": "string"
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

Workers 可观测性告警

{
    "account_id": "9035f53656c247e895c5a6939ae8a0e0",
    "alert_correlation_id": "000eaa907ed24e78946d3a93adb2ae57",
    "alert_event": "ALERT_STATE_EVENT_START",
    "alert_type": "workers_observability_alert",
    "data": {
        "account": {
            "id": "string",
            "name": "string"
        },
        "config": {
            "id": "string",
            "name": "string"
        },
        "episode": {
            "first_failed": "2006-01-02T15:04:05Z",
            "first_fired": "2006-01-02T15:04:05Z",
            "id": "string",
            "last_failed": "2006-01-02T15:04:05Z",
            "resolved_at": "2006-01-02T15:04:05Z",
            "summary": "string"
        },
        "status": "PENDING"
    },
    "name": "Example Cloudflare Notification",
    "policy_id": "749b911ea5d04344a58e45edd099b328",
    "policy_name": "Example Cloudflare Notification",
    "text": "The description of my Cloudflare notification.",
    "ts": 1136214245
}

验证 Webhook 载荷

您可以使用 cf-webhook-auth 标头来验证传入的 Webhook 是否来自 Cloudflare。当您配置带有密钥的 Webhook 时,Cloudflare 会在每个请求中包含此标头及您的密钥值。请拒绝任何缺少此标头或标头值与您配置的密钥不匹配的请求。

相关资源

这篇文档对您有帮助吗?