伙伴云OpenAPI
  1. 订阅
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 获取表格列表
      POST
    • 获取表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 创建数据
      POST
    • 更新数据
      PUT
    • 删除数据
      DELETE
    • 批量创建数据
      POST
    • 批量更新或创建数据
      PUT
    • 批量删除数据
      DELETE
  • 数据仓库数据
    • 获取数据仓库表格列表
      POST
    • 获取数据仓库表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 批量创建数据
      POST
    • 批量更新数据
      PUT
    • 根据数据ID列表更新成相同数据
      PUT
    • 批量删除数据
      DELETE
  • 流程
    • 获取流程列表
    • 查询流程实例列表
    • 获取流程实例详情
    • 获取流程实例的执行记录
    • 查询流程任务列表
    • 获取流程任务详情
  • 文件
    • 批量获取文件详情
    • 上传文件
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
      POST
    • 取消订阅
      POST
    • 获取订阅列表
      POST
  • 服务商
    • 获取 access_token
    • 获取服务商的 api_key
    • 获取服务商信息
    • 设置订阅回调地址
    • 获取订阅回调地址
  • 数据模型
    • 通用模型
      • Space
        • 工作区
        • 封面
      • Table
        • Config
          • text 文本类型
          • date 日期类型
          • category 选项类型
          • user 用户类型
          • relation 关联类型
          • signature 签名类型
          • file 文件类型
          • location 位置类型
          • numeric 数字类型
        • 字段配置
        • 字段列表
        • 表格配置
        • 表格
        • 数据仓库表格配置
      • Item
        • Field
          • signature 签名
          • location 位置
          • file 文件
          • text 文本
          • numeric 数字
          • date 日期
          • category 选项
          • user 用户
          • relation 关联
        • 数据
        • 字段值
        • 字段提交
      • Filter
        • Query
          • Eqm
          • Eq
          • Ne
          • Gt
          • Gte
          • Lt
          • Lte
          • In
          • Ain
          • Nin
          • Inc
          • Em
        • Connector
          • And
          • Or
        • Filter
        • Query
        • Condition
        • Connector
      • Object
        • 用户
        • 备选项
        • 位置
        • 文件
        • 签名
      • Procedure
        • 流程
        • 流程实例
        • 流程执行记录
        • 流程任务
    • 业务模型
      • 订阅
      • 回调信息
      • 服务商信息
      • 企业信息
    • 异常报错
    • 全局返回
  1. 订阅

添加订阅

POST
https://api.huoban.com/openapi/v1/event/subscribe
可以对指定的一个表格订阅数据的创建、修改、删除事件,当数据发生订阅的数据变化后,会将数据内容推送到回调地址。
可以对指定的一个流程订阅流程的发起及变更、任务的发起及变更事件,当流程发生订阅的变化后,会将流程实例及流程任务推送到回调地址。
企业可在企业后台的“接口授权”中的每个 API Key 上设置回调地址,服务商可调用“设置订阅回调地址”的接口设置回调地址。

请求参数

Header 参数

Body 参数application/json

示例
{
    "source_id": "{{TABLE_ID}}",
    "source_type": "table",
    "events": [
        "item.create",
        "item.update",
        "item.delete"
    ]
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.huoban.com/openapi/v1/event/subscribe' \
--header 'Open-Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "source_id": "",
    "source_type": "table",
    "events": [
        "item.create",
        "item.update",
        "item.delete"
    ]
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "message": "success",
    "data": {
        "subscribe": {
            "source_id": "2100000014303340",
            "source_type": "table",
            "events": [
                "item.update",
                "item.create"
            ],
            "state": 1
        }
    },
    "meta": {
        "trace_id": "1652588545784032"
    }
}
修改于 2025-05-19 03:45:11
上一页
订阅回调事件
下一页
取消订阅
Built with