如何使用 Webhook

## 1.什么是Webhook
WebHook（网络钩子）是一种机制，允许应用程序在发生特定事件时通知其他服务。简而言之，WebHook 是一种用户定义的HTTP回调，即当预定义的事件发生时，服务器会作出响应，主动向一个特定的URL发出HTTP请求（通常是POST请求），并将事件的相关数据作为负载（payload）发送给该URL指定的服务。
## 2. Webhook可以实现什么功能
用户可以通过webhook地址向空间内部的群推送群消息，一般可以用来实现日志报警通知、数据推送通知等能力。
这里以SLS日志告警为示例演示如何将企安盟Webhook机器人与外部系统结合实现日志报警通知。
- 新建日志告警，选择极简模式--渠道选择通用WebHook

![](/media/202411/2024-11-21_212213_7648590.2133120424303967.png)
- 选择Webhook，如果没有创建过Webhook，点击新增，配置一个自定义Webhook。注意请求地址需要配成企安盟通知机器人对应的地址

![](/media/202411/2024-11-21_212226_3459500.822040369826162.png)
- 选择内容模版，如果没有需要创建一个，点击新增，配置一个自定义模版。模版类型选择-WebHook自定义，发送方式选择逐条发送，发送内容即请求体，格式如下。这里还可以插入SLS支持的变量，获取告警的相关信息。

![](/media/202411/2024-11-21_212237_7203940.24728619592063605.png)
- 这样就完成了一个Webhook通知的配置，当告警规则触发时，SLS就会自动往对应的webhook地址推送告警通知。

![](/media/202411/2024-11-21_212249_5135930.7252580020674431.png)
## 3.如何向指定的webhook地址发送请求
向生成的webhook地址发送post请求即可，可参考如下请求示例
注意：目前消息类型只支持text
请求url:POST 创建机器人时返回的webHook地址

请求体：
{
    "msgType": "text",
    "msgContent": "欢迎使用企安盟！如果你在使用过程中遇到什么问题，请随时回到智能助手中进行提问或反馈。可以试着向我提问：如何购买联盟."
}
响应体：
{
    "code": 0,
    "message": "success",
    "error": null,
    "data": {
        "msgId": "af03f4f2e35d4cbc83c3b034b17728d8",
        "requestId": "a3b75833e4cc4143a55b1dde4b6b50dc"
    },
    "success": true
}    
import com.google.gson.Gson;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import okhttp3.RequestBody;
import okhttp3.MediaType;
import okhttp3.Response;
import java.util.HashMap;
import java.util.Map;

public class OkHttpPostJsonExample {
    public static final MediaType JSON = MediaType.get("application/json; charset=utf-8");

public static void main(String[] args) {
        // 创建一个Map并填充数据
        Map<String, Object> map = new HashMap<>();
        map.put("msgType", "text");
        map.put("msgContent", "欢迎使用企安盟！如果你在使用过程中遇到什么问题，请随时回到智能助手中进行提问或反馈。可以试着向我提问：如何购买联盟.");

// 使用Gson将Map转换为JSON字符串
        Gson gson = new Gson();
        String json = gson.toJson(map);

// 创建OkHttpClient实例
        OkHttpClient client = new OkHttpClient();

// 创建RequestBody
        RequestBody body = RequestBody.create(json, JSON);

// 构建请求
        Request request = new Request.Builder()
                .url("https://api.seinstantmessage.com/open-robot/send?accessToken=xxxxxxxxxxxxxxxxxxxxxx")
                .post(body)
                .build();

// 发送请求并处理响应
        try (Response response = client.newCall(request).execute()) {
            if (response.isSuccessful() && response.body() != null) {
                System.out.println(response.body().string());
            } else {
                System.out.println("Request failed: " + response.code());
            }
        } catch (Exception e) {
            e.printStackTrace();
        }
    }
}