测试 Webhook 连接

向指定的 Webhook URL 发送测试消息以测试 Webhook 连接。

请求 URL

GET {base_url}/{api_path}/webhook/test?access_token={access_token}

请求参数

参数 是否必填 类型 说明
url 是 String 已配置的 Webhook 的 URL。
注： 你可以使用 查询 Webhook 事件推送设置 接口获取已配置的 Webhook URL。
secret 是 String 与指定的 Webhook URL 对应的密钥。

此密钥用于为 Webhook 消息生成 HMAC-SHA256 签名。消息接收者可使用此密钥验证消息的真实性和完整性。

注： 可使用 查询 Webhook 事件推送设置 接口获取 Webhook URL 及其对应的密钥。
request_method 是 String 向 Webhook URL 发送请求的 HTTP 请求方法。
取值范围：
  • GET
  • POST

响应参数

参数 类型 说明
errcode Integer 返回错误码。
  • 0：请求成功。
  • 非零值：请求失败。
注： 更多错误码和错误信息说明，请参见 错误码 & 错误信息。
errmsg String 返回信息。
  • SUCCESS：请求成功。
  • FAILURE：请求失败。

示例

请求示例

GET /openapi/v1.0/webhook/test?access_token=DEfChNyQmVMUZip90i8PqCfotJL7kIQB&request_method=POST&secret=qnIdTBxyGgn2LckZrFw7IVeTRMJf3XfM&url=https://webhook.site/38e9dea1-be68-4381-8a8c-f0623517f513 HTTP/1.1

Host: yeastardocs.example.yeastarcloud.com

响应示例

HTTP/1.1 200 OK
{
    "errcode": 0,
    "errmsg": "SUCCESS"
}