Skip to main content
POST
创建 Webhook

授权

X-API-KEY
string
header
必填

生产环境 API Key,可在 ADP 平台的「我的 API」中查看。请确保 API Key 有效且属于生产环境。

路径参数

tenant_name
string
默认值:laiye
必填

租户名称,默认 laiye。

请求体

application/json
webhook_url
string<uri>
必填

由调用方控制的公网 HTTPS 回调地址。公共合同不接受 HTTP 或内网地址。

Maximum string length: 512
Pattern: ^https://
event_types
enum<string>[]
必填
Minimum array length: 1
可用选项:
doc_parse_completed,
doc_extract_completed,
collaboration_start,
collaboration_success,
collaboration_failed,
collaboration_completed,
collaboration_timeout
app_id
string[] | null

应用范围;省略、null 或空数组表示当前账号的全部应用。

Minimum string length: 1

响应

Webhook 创建或修改结果。

code

业务码。成功通常为 success 或 200。

message
string

返回信息。

tips
string | null

详细信息,默认为空。

data
object | null