版本 2.1.1792967583 · 最新 下载 OpenAPI Markdown 版

告警 Webhook

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

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

告警 Webhook 列表

GET/api/v2/message-webhooks
鉴权: 仅管理员

查询参数

字段类型必填说明
pageinteger— 页码,从 1 开始。
默认 1
page_sizeinteger— 每页条数。
默认 20

新建告警 Webhook

POST/api/v2/message-webhooks
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
chat_idstring— Telegram 会话(数字 id 或 @频道名)。
created_atstring必填 创建时间
enabledboolean— 是否启用;停用的不发。缺省启用。
idinteger必填 记录 ID
kindstring必填 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
last4string— 地址(Telegram 为 Token)的末 4 位,仅用于辨认。
namestring必填 名称,全局唯一。
secretstring— Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
updated_atstring必填 更新时间
urlstring— 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。

测试未保存的告警 Webhook

POST/api/v2/message-webhooks/test
鉴权: 仅管理员

请求体 application/json

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

修改告警 Webhook

PUT/api/v2/message-webhooks/{id}
鉴权: 仅管理员

请求体 application/json

字段类型必填说明
chat_idstring— Telegram 会话(数字 id 或 @频道名)。
created_atstring必填 创建时间
enabledboolean— 是否启用;停用的不发。缺省启用。
idinteger必填 记录 ID
kindstring必填 类型:dingtalk 钉钉、feishu 飞书、wecom 企业微信、telegram Telegram、generic 通用 JSON。
可选值 ["dingtalk","feishu","wecom","telegram","generic"]
last4string— 地址(Telegram 为 Token)的末 4 位,仅用于辨认。
namestring必填 名称,全局唯一。
secretstring— Telegram 为 Bot Token(必填);其余为加签密钥(可空)。只写,不回显。
updated_atstring必填 更新时间
urlstring— 机器人地址(https,公网;钉钉、飞书、企业微信、通用必填;Telegram 不用)。只写,不回显。

删除告警 Webhook

DELETE/api/v2/message-webhooks/{id}
鉴权: 仅管理员

测试已保存的告警 Webhook

POST/api/v2/message-webhooks/{id}/test
鉴权: 仅管理员

告警 Webhook对象

字段类型必填说明
chat_idstring— Telegram 会话(数字 id 或 @频道名)。
created_atstring— 创建时间
只读
enabledboolean— 是否启用;停用的不发。缺省启用。
errorstring— 失败时的错误信息。
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 不用)。只写,不回显。