版本 2.4.7.20261116085428 · 最新

告警 Webhook message-webhooks

钉钉、飞书、企业微信、Telegram 与通用 JSON 告警出口,可配多个,地址与密钥只回后 4 位。

点击任一接口,右侧显示对应的调用示例。

消息鉴权: 仅管理员6 个接口

鉴权

请求头带 X-API-Key(在「API 密钥」页开通,密钥只在开通时显示一次);也可用登录得到的 Authorization: Bearer 令牌。

X-API-Key

鉴权失败回 401;无权回 403(code 为 insufficient_scope 等)。

约定

分页参数 page(从 1 起)、page_size;排序 sort=字段 或 -字段。

时间一律 RFC 3339(UTC);金额单位为分。

写操作成功回 200/201/204;重复提交按资源唯一键回 409。

GET/api/v2/message-webhooks告警 Webhook 列表

鉴权: 仅管理员

查询参数

字段类型说明
pageinteger 页码,从 1 开始。
默认 1
page_sizeinteger 每页条数。
默认 20
POST/api/v2/message-webhooks新建告警 Webhook

鉴权: 仅管理员

请求体 application/json

字段类型说明
chat_idstring Telegram 会话(数字 id 或 @频道名)。
created_at必填string 创建时间
enabledboolean 是否启用;停用的不发。缺省启用。
eventsstring[] 接收的事件类型:alert 平台告警、ticket 工单。新建不给 = 全部;修改不给 = 保留原值;空数组 422。
id必填integer 记录 ID
kind必填string 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
last4string 地址(Telegram 为 Token)的末 4 位,仅用于辨认。
name必填string 名称,全局唯一。
secretstring Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
updated_at必填string 更新时间
urlstring 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。
POST/api/v2/message-webhooks/test测试未保存的告警 Webhook

鉴权: 仅管理员

请求体 application/json

字段类型说明
chat_idstring Telegram 会话(数字 id 或 @频道名)。
idinteger 记录 ID
kind必填string 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
secretstring Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
urlstring 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。
PUT/api/v2/message-webhooks/{id}修改告警 Webhook

鉴权: 仅管理员

请求体 application/json

字段类型说明
chat_idstring Telegram 会话(数字 id 或 @频道名)。
created_at必填string 创建时间
enabledboolean 是否启用;停用的不发。缺省启用。
eventsstring[] 接收的事件类型:alert 平台告警、ticket 工单。新建不给 = 全部;修改不给 = 保留原值;空数组 422。
id必填integer 记录 ID
kind必填string 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
last4string 地址(Telegram 为 Token)的末 4 位,仅用于辨认。
name必填string 名称,全局唯一。
secretstring Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
updated_at必填string 更新时间
urlstring 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。
POST/api/v2/message-webhooks/{id}/test测试已保存的告警 Webhook

鉴权: 仅管理员

告警 Webhook对象

字段类型说明
chat_idstring Telegram 会话(数字 id 或 @频道名)。
created_atstring 创建时间
只读
enabledboolean 是否启用;停用的不发。缺省启用。
errorstring 失败时的错误信息。
eventsstring[] 接收的事件类型:alert 平台告警、ticket 工单。新建不给 = 全部;修改不给 = 保留原值;空数组 422。
idinteger 记录 ID
只读
kindstring 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
last4string 地址(Telegram 为 Token)的末 4 位,仅用于辨认。
只读
namestring 名称,全局唯一。
okboolean 测试发送是否成功。
secretstring Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
updated_atstring 更新时间
只读
urlstring 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。

返回与错误

成功直接回资源 JSON(HTTP 2xx);失败回 application/problem+json(code、detail,校验失败带 errors);列表为 items + total。

成功
{
  "id": 1,
  "name": "example"
}
列表
{
  "items": [
    {
      "id": 1
    }
  ],
  "page": 1,
  "page_size": 20,
  "total": 1
}
失败
{
  "code": "validation_failed",
  "detail": "请求参数不合法",
  "errors": [
    {
      "code": "required",
      "field": "/name",
      "message": "name 必填"
    }
  ],
  "request_id": "0123456789abcdef",
  "status": 422,
  "title": "Unprocessable Entity",
  "type": "about:blank"
}
开始使用

123

123