跳转到主要内容
POST
测试应用 Webhook

限制说明

使用说明

  • URL 必须使用 http 或 https;在 Flashduty 云端,解析到私有、回环、链路本地或保留地址的主机会被拒绝并返回 InvalidParameter。
  • 样例请求体与真实告警事件结构相同:account_id、data_source_type(rum.alert)、title、event_severity、event_status、description、alert_key、labels 以及 event_time(Unix 秒)。
  • 每次尝试 10 秒超时;传输错误、5xx 和 429 响应最多重试 2 次。
  • 投递失败时仍返回 HTTP 200,ok 为 false,原因在 message 中。
  • 调用者须对该应用有编辑权:账户所有者、账户管理员、应用创建者或所属团队成员,否则返回 AccessDenied。

授权

app_key
string
query
必填

在 Flashduty 控制台 我的 → APP Key 中创建的 APP Key。可通过 query 参数 app_key 或请求头 Fd-App-Key 传入。实际可访问范围是该 APP Key 的权限范围与创建者当前角色权限的交集,请妥善保管。

请求体

application/json

发送 RUM 告警样例 Webhook 的参数。

application_id
string
必填

RUM 应用 ID,其名称会写入样例事件的 labels.application_name。调用者须对该应用有编辑权。可通过 POST /rum/application/list 获取应用 ID。

webhook_url
string<uri>
必填

接收样例告警事件的 Webhook URL,必须使用 http 或 https。不会被保存:如需保存,请通过 POST /rum/application/update 设置 alerting.webhook_url。

响应

成功

成功响应结构。2xx 响应中 request_id 标识本次调用(同时出现在 Flashcat-Request-Id 响应头中),data 为接口业务 payload。失败响应使用不同结构,参见 ErrorResponse。

request_id
string
必填

本次请求的唯一 ID,也会在 Flashcat-Request-Id 响应头中返回。反馈问题时请一并附上。

示例:

"01HK8XQE3Z7JM2NTFQ5YJ8P9R4"

data
object

Webhook 测试投递结果。