Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

查询全部 Hook 订阅

请求说明

请求地址https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/hooks
请求方法GET
签名方式KSO-1
权限要求管理多维表格(用户授权) kso.dbsheet.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
file_idstring文件 id

查询参数(Query)

名称参数类型是否必填说明
with_detailbool是否返回 hook 规则详情,默认 false

请求地址示例

[GET] https://openapi.wps.cn/v7/coop/dbsheet/{file_id}/hooks?with_detail=true

响应体

名称参数类型说明
hooksobject已订阅 hook 列表
∟ keystringhook id
∟ valueobjectHook 详情
∟ ∟ callback_urlstring回调地址
∟ ∟ file_idstring文件 id
∟ ∟ hook_idstringhook id
∟ ∟ user_idstring发起 hook 的用户
∟ ∟ detailobject订阅规则详情(仅当 with_detail=true 时返回)
∟ ∟ ∟ commandstring订阅命令
∟ ∟ ∟ dataobject订阅规则,参考不同规则说明

响应体示例

{
  "hooks": {
    "hook_id123": {
      "callback_url": "https://example.com/hook",
      "file_id": "abcdefg",
      "hook_id": "hook_id123",
      "user_id": "user_001",
      "detail": {
        "command": "create_record",
        "data": {
          "sheet_id": 1001
        }
      }
    }
  }
}
回到旧版