添加订阅 - 伙伴云OpenAPI

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

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

source_id

string

订阅的对象ID

必需

source_type

string

订阅的对象类型

必需

目前仅支持“table”表格、”procedure“流程

events

array[string]

订阅的事件

必需

枚举值:

item.createitem.updateitem.deleteprocess.createprocess.updatetask.createtask.update

示例

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

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

object (订阅)

必需

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "subscribe": {
      "source_id": "2100000014303340",
      "source_type": "table",
      "events": [
        "item.update",
        "item.create"
      ],
      "state": 1
    }
  },
  "meta": {
    "trace_id": "1652588545784032"
  }
}