Skip to content

关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强:钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

认证 ​

此提供商需要身份验证。

  • service_region: 服务区域:EU/US(必需:True,敏感:False)
  • refresh_token: Squadcast 刷新令牌(必需:False,敏感:True)
  • webhook_url: 事件 webhook URL(必需:False,敏感:True)

某些范围可能需要才能通过提供商执行特定操作或查询。以下是相关范围及其用例的摘要:

  • authenticated: 用户可以连接到客户端

在工作流中 ​

此提供商可用于工作流。

作为"操作"来进行更改或更新数据,示例:

yaml
actions:
    - name: Query squadcast
      provider: squadcast
      config: "{{ provider.my_provider_name }}"
      with:
        notify_type: {value}
        message: {value}
        description: {value}
        incident_id: {value}
        priority: {value}
        tags: {value}
        status: {value}
        event_id: {value}
        attachments: {value}
        additional_json: {value}

请查看以下工作流示例:

输入 ​

notify 函数将以下参数作为输入:

  • notify_type(必填):取 incident 或 notes 之一,取决于您是要创建事件还是备注。
  1. incident 的参数 ​
    • message(必填):这将是事件消息。
    • description(必填):这将是事件描述。
    • tags(可选):事件的标签。它应该是字典格式。
    • priority(可选):事件的优先级。
    • status(可选):事件的状态。
    • event_id(可选):event_id 用于解决事件
    • additional_json(可选):要与事件一起发送的附加 JSON 数据。
  2. notes 的参数 ​
    • message(必填):备注的消息。
    • incident_id(必填):要创建备注的事件的 ID。
    • attachments(可选):备注的附件列表。

查看 文档 了解更多

连接 Provider ​

  1. 前往 Refresh Tokens 了解如何创建 refresh_token。
  2. 访问 Documentations 了解如何设置 incident_webhooks 并获取 webhook_url

相关链接 ​

基于 MIT 协议开源的 Keep · 由更夫社区维护