Flashcat API
FlashdutyNightingaleFlashcat帮助文档官网控制台
FlashdutyNightingaleFlashcat帮助文档官网控制台
  1. Webhook
  • 介绍
  • Open API
    • 快速入门
    • 关于分页
    • 成员管理
      • 邀请成员
      • 重置信息
      • 删除成员
      • 成员列表
    • 团队管理
      • 团队列表
      • 基本信息
      • 团队删除
      • 团队Upsert
    • 值班管理
      • 创建值班表
      • 更新值班表
      • 预览值班表
      • 删除值班表
      • 查看值班详情
      • 查看值班列表
      • 个人值班日程
      • 根据ID列表获取值班表信息
      • 角色信息
    • 信息获取
      • 人员
      • 团队
      • 协作空间
    • 偏好设置
      • 查看偏好设置
      • 修改偏好设置
    • 协作空间
      • 分派策略
        • 策略详情
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 订阅规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 排除规则
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 静默策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 抑制策略
        • 策略启用
        • 策略禁用
        • 策略删除
        • 策略列表
        • 策略创建
        • 策略更新
      • 空间列表
      • 空间详情
      • 空间创建
      • 空间更新
      • 空间启用
      • 空间禁用
      • 空间删除
      • 空间排序
      • 空间收藏
      • 取消收藏
      • 机器人列表
      • 按集成查询空间名称
    • 模板管理
      • 模板列表
      • 模板详情
      • 模板启用
      • 模板禁用
      • 模板删除
      • 模板预览
      • 模板创建
      • 模板更新
    • 故障管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 创建故障
      • 分派故障
      • 添加处理人
      • 认领故障
      • 取消认领
      • 关闭故障
      • 重开故障
      • 删除故障
      • 屏蔽故障
      • 取消屏蔽
      • 合并故障
      • 评论故障
      • 故障详情
      • 故障列表
      • 故障列表-卡片视图
      • 故障列表-按ID查询
      • 历史故障列表
      • 故障时间线
      • 标题更新
      • 描述更新
      • 影响更新
      • 根因更新
      • 解决方案更新
      • 严重程度更新
      • 关联告警列表
      • 自定义字段更新
      • 触发自定义操作
    • 告警管理
      • 聚合视图
        • 视图删除
        • 视图列表
        • 视图创建
        • 视图更新
      • 告警详情
      • 关闭告警
      • 告警列表-卡片视图
      • 告警列表
      • 告警列表-按ID查询
      • 关联-事件列表
      • 时间线
      • 合并到故障
    • 变更管理
      • 变更列表
    • 自定义字段
      • 字段列表
      • 字段详情
      • 字段删除
      • 字段创建
      • 字段更新
    • 服务日历
      • 日历列表
      • 日历详情
      • 日历创建
      • 日历更新
      • 日历删除
      • 日历事件设置
      • 日历事件删除
      • 日历事件列表
    • 标签增强
      • Mapping
        • 查询schema
        • 创建schema
        • 更新schema
        • 删除schema
        • 查询data
        • 更新data
        • 删除data
        • 清空data
        • csv上传data
        • csv下载data
      • 规则详情
      • 规则更新
    • 告警处理
      • 规则详情
      • 规则更新
    • 集成路由
      • 路由历史列表
      • 路由列表
      • 路由详情
      • 路由更新
    • License管理
      • License成员列表
      • 修改成员License类型
    • 分析看板
      • 告警标签TOP
      • 账户维度指标
      • 故障明细查询
      • 故障明细导出
      • 团队维度指标
      • 团队维度指标导出
      • 空间维度指标
      • 空间维度指标导出
      • 个人维度指标
      • 个人维度指标导出
      • 通知数量
      • 变更数量
  • Webhook
    • 快速入门
    • 自定义操作
    • 故障 Webhook
    • 告警 Webhook
  • Event API
    • 快速入门
    • 告警 Event
    • 变更 Event
  1. Webhook

告警 Webhook

配置故障 Webhook,当故障发生特定操作(如触发、关闭)时,系统通过 HTTP 回调您配置的地址。回调内容将包含故障最新关键信息,您可以与自研工具进行集成。

一、事件类型#

目前支持以下事件类型,未来可能会增加。
事件类型释义
i_new创建故障(自动或手动创建)
i_assign分派故障(自动或手动分派)
i_snooze手动屏蔽故障
i_wake取消屏蔽故障
i_ack手动认领故障
i_unack取消认领故障
i_storm触发风暴预警
i_custom触发自定义操作
i_rslv关闭故障(自动或手动关闭)
i_reopen重新打开故障
i_merge手动合并故障
i_r_title更新故障标题
i_r_desc更新故障描述
i_r_impact更新故障影响
i_r_rc更新故障根因
i_r_rsltn更新故障解决办法
i_r_severity更新故障严重程度
i_r_field更新故障自定义字段

二、推送描述#

请求方式#

POST, Content-Type:"application/json"

请求 Payload:#

字段类型必含释义
event_timeint64是事件发生毫秒时间戳
event_typestring是事件类型,枚举值见事件类型
event_idstring是事件 ID,同一个事件可能因为超时等原因重试多次,接收方需要能够去重
personPerson否操作人,仅人为动作时存在
incidentIncident是故障详情
Person:
字段类型必含释义
person_idint64是人员 ID
person_namestring是人员名称
emailstring是邮件地址
Responder:
字段类型必含释义
person_idint64是人员 ID
person_namestring是人员名称
emailstring是邮件地址
assigned_atint64否分派时间
acknowledged_atint64否认领时间
Incident:
字段类型必含释义
incident_idstring是故障 ID
titlestring是故障标题
descriptionstring否故障描述
impactstring否故障影响
root_causestring否故障根本原因
resolutionstring否故障解决办法
incident_severitystring是严重程度,枚举值:Critical,Warning,Info
incident_statusstring是故障状态,枚举值:Critical,Warning,Info,Ok
progressstring是处理进度,枚举值:Triggered,Processing,Closed
created_atint64是创建时间
updated_atint64是更新时间
start_timeint64是触发时间,Unix 秒时间戳
last_timeint64否最新事件时间,关联告警中的最新事件推送时间,Unix 秒时间戳,默认为 0
end_timeint64否恢复时间,关联的告警全部恢复时,故障也会自动恢复,Unix 秒时间戳,默认为 0
ack_timeint64否首次认领时间,故障可被多人认领,此时间为最早的认领时间。Unix 秒时间戳,默认为 0
close_timeint64否关闭时间,end_time代表故障恢复时间,close_time代表处理进度的关闭时间,故障恢复时会同时关闭,故障关闭时不影响故障恢复。Unix 秒时间戳,默认为 0
snoozed_beforeint64否屏蔽截止时间
labelsmap[string]string否标签 KV,Key 和 Value 均为字符串。手动创建时无此信息,自动创建时为聚合的第一条告警的标签信息
fieldsmap[string]interface{}否自定义字段 KV,Key 为字符串,Value 可能为任意类型,取决于字段类型
creatorPerson否创建人员信息,仅手动创建故障时存在
closerPerson否关闭人员信息,仅手动关闭故障时存在
responders[]Responder否处理人员信息列表
alert_cntint64否关联告警个数
channel_idint64否协作空间ID,为0代表不属于任何空间
channel_namestring否协作空间名称
detail_urlstring是详情地址
group_methodstring否聚合方式,枚举值:n:不聚合,p:按规则聚合,i:智能聚合

请求响应#

HTTP status code 为 200,认为推送成功。

请求示例#

三、常见问题#

1.
服务是否有响应超时时间?
服务需要在 1 秒内返回响应,超过 1 秒则认为响应失败
2.
推送失败后是否会持续推送?
目前 FlashDuty 最多推送一次,未来可能会引入重试机制,也可能因为中间链路超时导致重试,您需要做好幂等处理
3.
如何保证推送顺序?
理论上同一个故障的事件是按照时间顺序进行推送,但是重试等情况可能会导致乱序
服务可以根据 event_time 进行过滤,如果已经收到了更晚的事件,可以直接过滤掉更早的事件,每一次推送都会携带最新的、完整的信息,偶尔丢失事件是可以容忍的
4.
推送来源可信 IP 白名单?
47.94.95.118, 123.56.8.183, 47.94.193.81, 1.13.19.96
未来可能会更新,请定期查验

添加官方技术人员微信

在这里,获得使用上的任何帮助,快速上手企业告警一站式响应平台FlashDuty

微信扫码交流
修改于 2024-11-21 11:06:37
上一页
故障 Webhook
下一页
快速入门
Built with