跳转到主要内容

是什么

异步任务完成后,VMEG 向你配置的 Webhook URL 发送 HTTP POST,请求体为 JSON。请按 Webhook 签名校验 校验 X-TimestampX-Signature create-async 的 HTTP 响应只表示受理(taskId 等)。成品在 Webhook 请求体中返回,不在该响应里。

公共结构

各类异步完成回调共用以下顶层字段;产品相关字段在 data 中:

pipelineKey 去重

VMEG 为每次已受理的异步任务分配一个 pipelineKey,并在该次完成的所有 Webhook POST 中携带。
pipelineKey 用于 Webhook 投递去重,与 create-async 上的 X-Idempotency-Key(防止重复提交任务)不是同一概念。一次已受理的异步任务对应一个 pipelineKeydata.taskId 标识任务,但重试去重应以 pipelineKey 为准。

event 字段

eventJSON 请求体里的字符串,表示是哪条 Open API 产品线的异步任务已结束。请用它做路由(先根据 event 分支,再解析 data)。
API 参考 里各 create-async 页面下的 Callbacks 区块名称来自 OpenAPI 工具命名。集成时请以 POST JSON 里的 event 字段取值为准,不要依赖该区块标题字面量。

各产品对应的 event

当前异步任务完成回调 仅使用 以上四种 event。若后续新增回调类型,会同步更新本文与各接口 Callbacks 说明。

处理示例

各接口的请求 schema

字段类型与嵌套结构见 API 参考中各 create-async 操作下的 Callbacks(上表已链到对应页面)。