设置订阅回调地址 - 伙伴云OpenAPI

通过服务商的 access_token 获得的企业 api_key 进行事件订阅后，当订阅的表格数据发生增、删、改后，会回调服务商通过该接口设置的订阅回调地址。
不同的企业 api_key 需要单独设置回调地址，不同的企业 api_key 订阅同一个表格的数据变更后，每个订阅均会收到回调。

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

callback_url

string

回调URL

必需

用于接收订阅事件的数据推送

encrypt_key

string

加密密钥

可选

如果对消息内容的安全级别要求较高，请配置加密秘钥，推送事件时会使用该密钥对消息内容做对称加密

示例

{
  "callback_url": "https://app.huoban.com",
  "encrypt_key": ""
}

示例代码

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

必需

meta

object

元数据

必需

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

trace_id

string

请求ID

必需

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

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "callback_url": "https://app.huoban.com",
    "encrypt_key": "",
    "valid_url_state": 1
  },
  "meta": {
    "trace_id": "1654076757682019"
  }
}