告警接入 - WebHook通知数据交互格式 - 《哮天犬告警平台》

约定
- 格式
示例请求

约定

哮天犬发送webhook通知，约定请求方式为 POST，请求Header中 User-Agent 包含 dog/ ，例如 User-Agent: dog/1.0，请求参数使用body部分传输 json，即请求header中包含 Content-Type: application/json，json的内容格式约定如下：

{
  "event": "{EVENT}",
  "type": "{TYPE}",
  "data": {
    // 提交的data数据
  },
  "extra": {
    // 其他附加字段
  }
}

约定webhook响应状态码为 200 即为成功，无论响应的数据是什么。
调用webhook的超时时间为200毫秒，请注意优化webhook性能，避免超时。

格式

以上body部分的取值请参考：

| event (String) | type (String) | body (Object) | extra (Object) | 说明 | | —- | —- | —- | —- | —- |

    | 
        PING
         | ping
         | 无
         | 
         | 用于测试该webhook是否可用
     |
    | 
        ALARM
         | not_save_db
         |

         | 
         | 未入库告警通知
     |
    |  | 
        compressed
         |

         | 
         | 收敛告警通知
     |
    |  | 
        compress_not_match
         |

         | 
         | 未收敛告警通知
     |
    |  | 
        compress_disable
         |

         | 
         | 未开启收敛功能告警通知
     |
    | 
        UPGRADE
         | upgrade
         |

         | 
         | 告警升级通知
     |
    | 
        RECOVERY
         | not_save_db
         |

         | 
         | 告警恢复通知（不入库类型）
     |
    |  | 
        recovery
         |

         | 
         | 告警恢复通知（入库类型）
     |
    | 
        WORKFLOW
         | remind_pending
         |

         | 
         | 待认领工作流提醒通知
     |
    |  | 
        remind_processing
         |

         | 
         | 待处理完成工作流提醒通知
     |
    |  | 
        generated
         |

         | 
         | 工作流创建提醒
     |
    |  | 
        claim
         |

         | 
         | 工作流认领通知
     |
    |  | 
        assign
         |

         | 
         | 工作流指派通知
     |
    |  | 
        processed
         |

         | 
         | 工作流处理完成通知
     |
    |  | 
        reactive
         |

         | 
         | 工作流被重新激活通知
     |
    |  | 
        close
         |

         | 
         | 工作流关闭通知
     |

说明：上表中 task.id、task.name 表示的是JSON中的Object：

{
    "task": {
        "id": 123,
        "name": "哮天犬测试"
    }
}

上表中 pipeline.assignto..uid、pipeline.assignto..username 表示的是JSON中的Array：

{
    "pipeline": {
        "assignto": [
            {
                "uid": 123,
                "username": "张三"
            },
            {
                "uid": 456,
                "username": "李四"
            }
        ]
    }
}

示例请求

POST /admin HTTP/1.1
Content-Length: 467
User-Agent: dog/1.0
Content-Type: application/json
Host: localhost:9501
{"event":"WORKFLOW","type":"close","data":{"workflow":{"id":1,"task_id":102,"history_id":3,"created_at":"1970-01-06 08:07:12","status":"\u5904\u7406\u4e2d"},"task":{"id":102,"name":"\u7530\u7247\u6d4b\u8bd5"},"history":{"id":3,"uuid":"e3c25704-a54b-40ab-ab08-0e2009d9673e","level":"\u9519\u8bef"},"pipeline":{"remark":"423","created_at":"2020-05-02 23:27:51","user":{"uid":1,"username":"ethananony","email":"ethananony@aliyun.com","user":"ethananony"}}},"extra":{}}