故障 webhook

配置故障 Webhook，当故障发生特定操作（如触发、关闭）时，系统通过 HTTP 回调您配置的地址。回调内容将包含故障最新关键信息，您可以与自研工具进行集成。

一、事件类型

目前支持以下事件类型，未来可能会增加。

二、推送描述

请求方式

请求 Payload：

请求响应

HTTP status code 为 200，认为推送成功。

请求示例

curl -X POST 'https://example.com/incident/webhook?a=a' \
-H 'Content-Type: application/json' \
-H 'X-Customize-Header-A: a' \
-d '{
    "event_id":"fac0599a2a25529ba2362c0c184b6cfb",
    "event_time":1689335086948,
    "event_type":"i_new",
    "incident":{
        "account_id":74058170041504,
        "account_name":"头铁科技kk",
        "ack_time":0,
        "alert_cnt":0,
        "assigned_to":{
            "assigned_at":1689335086,
            "escalate_rule_id":"64abb8a687e7984845822139",
            "escalate_rule_name":"默认分派",
            "id":"NBRbNwDSTSMijKXdLtBU3T",
            "layer_idx":0,
            "type":"assign"
        },
        "channel_id":1840312623504,
        "channel_name":"Reduce Noise",
        "close_time":0,
        "created_at":1689335086,
        "creator":{
            "email":"toutie@flashcat.cloud",
            "person_id":1552048792504,
            "person_name":"头铁"
        },
        "creator_id":1552048792504,
        "data_source_id":0,
        "dedup_key":"",
        "description":"",
        "detail_url":"http://10.206.0.17:8567/incident/detail/64b1352e376e32c85c56e25b",
        "end_time":0,
        "equals_md5":"",
        "group_method":"n",
        "impact":"",
        "incident_id":"64b1352e376e32c85c56e25b",
        "incident_severity":"Critical",
        "incident_status":"Critical",
        "labels":{
            "check": "cpu idle low"
        },
        "last_time":1689335086,
        "num":"56E25B",
        "progress":"Triggered",
        "resolution":"",
        "responder_ids":[
            1552048792504
        ],
        "responders":[
            {
                "acknowledged_at":0,
                "assigned_at":1689335086,
                "email":"toutie@flashcat.cloud",
                "person_id":1552048792504,
                "person_name":"头铁"
            }
        ],
        "root_cause":"",
        "snoozed_before":0,
        "start_time":1689335086,
        "title":"ysy028",
        "updated_at":1689335086
    },
    "person":{
        "email":"toutie@flashcat.cloud",
        "person_id":1552048792504,
        "person_name":"头铁"
    }
}' -v

三、常见问题

1. 服务是否有响应超时时间？

   • 服务需要在 1 秒内返回响应，超过 1 秒则认为响应失败

2. 推送失败后是否会持续推送？

   • 目前 FlashDuty 最多推送一次，未来可能会引入重试机制，也可能因为中间链路超时导致重试，您需要做好幂等处理

3. 如何保证推送顺序？

   • 理论上同一个故障的事件是按照时间顺序进行推送，但是重试等情况可能会导致乱序
   • 服务可以根据 event_time 进行过滤，如果已经收到了更晚的事件，可以直接过滤掉更早的事件，每一次推送都会携带最新的、完整的信息，偶尔丢失事件是可以容忍的

4. 推送来源可信 IP 白名单？

   • {ip_whitelist}
   • 未来可能会更新，请定期查验