# Webhook

无需轮询，只需为运行提供 `webhook_url`。当请求达到最终状态（`succeeded`、`failed` 或 `canceled`）时，我们会向该 URL 发送签名 `POST`。

```bash
curl -X POST "https://api.doitong.com/v1/run/{model_id}?webhook_url=https://example.com/hooks/doitong" \
  -H "Authorization: Bearer $DOITONG_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"prompt": "..."}'
```

> [!NOTE]
> URL 必须是公开的 `https://` 地址。私有、本地和非 HTTPS 地址会在扣费前被拒绝，并返回 `422 invalid_webhook_url`。

## 事件

```http 请求标头
POST /hooks/doitong HTTP/1.1
Content-Type: application/json
User-Agent: Doitong-Webhooks/1
Doitong-Request-Id: req_8k2m4q7x1z9c3v5b6n0p2r4t
Doitong-Signature: t=1760961609,v1=5f1c0d6e2b…
```

```json 请求体
{
  "id": "evt_8k2m4q7x1z9c3v5b6n0p2r4t_succeeded",
  "object": "event",
  "type": "request.succeeded",
  "created_at": "2026-10-20T12:00:09Z",
  "data": {
    "id": "req_8k2m4q7x1z9c3v5b6n0p2r4t",
    "object": "request",
    "status": "succeeded",
    "outputs": [ { "type": "video", "url": "https://content.doitong.com/dev-api/…/0-output.mp4" } ]
  }
}
```

- `type` 是 `request.succeeded`、`request.failed` 或 `request.canceled`。
- `data` 是完整的请求对象，与 `GET /requests/{id}` 返回的内容完全相同。
- `id` 对请求及其最终状态保持不变。使用它忽略已处理的投递。

## 投递与重试

在 10 秒内以任意 `2xx` 状态响应。其他响应（或超时）都会触发重试：总计最多 6 次，分别在 30 秒、2 分钟、10 分钟、1 小时和 6 小时后重试。请先响应，再执行耗时工作。

## 验证签名

每个密钥都有自己的签名密钥。从 `GET https://api.doitong.com/v1/account` 读取一次（`webhook_signing_secret`，以 `whsec_` 开头），并将其与 API 密钥一起存储。

`Doitong-Signature` 标头格式为 `t=<unix time>,v1=<signature>`，其中签名是对 `"<t>.<raw request body>"` 执行 HMAC-SHA256 后得到的十六进制值，密钥为你的签名密钥。验证步骤如下：

1. 完全按照接收时的原样获取原始请求体字节（在解析 JSON 之前）。
2. 使用你的签名密钥对 `t + "." + body` 计算 HMAC-SHA256，并输出小写十六进制结果。
3. 以恒定时间将其与 `v1` 比较。
4. 当 `t` 与本地时钟相差超过 5 分钟时拒绝事件（防重放）。

以下是使用 Node.js（Express）和 Python（Flask）的完整接收器：

```javascript Node.js · Express
import crypto from "node:crypto";
import express from "express";

const SECRET = process.env.DOITONG_WEBHOOK_SECRET; // whsec_...
const app = express();

app.post("/hooks/doitong", express.raw({ type: "application/json" }), (req, res) => {
  const header = req.get("Doitong-Signature") || "";
  const parts = Object.fromEntries(header.split(",").map((p) => p.split("=", 2)));
  const t = Number(parts.t);
  const expected = crypto.createHmac("sha256", SECRET).update(t + "." + req.body).digest("hex");
  const given = Buffer.from(parts.v1 || "", "utf8");
  const valid =
    given.length === expected.length &&
    crypto.timingSafeEqual(given, Buffer.from(expected, "utf8")) &&
    Math.abs(Date.now() / 1000 - t) < 300;
  if (!valid) return res.status(400).send("bad signature");

  const event = JSON.parse(req.body);
  if (event.type === "request.succeeded") {
    console.log(event.data.id, event.data.outputs.map((o) => o.url));
  }
  res.sendStatus(204);
});
```
```python Python · Flask
import hashlib
import hmac
import json
import os
import time

from flask import Flask, abort, request

SECRET = os.environ["DOITONG_WEBHOOK_SECRET"].encode()  # whsec_...
app = Flask(__name__)


@app.post("/hooks/doitong")
def doitong_hook():
    body = request.get_data()  # raw bytes
    parts = dict(p.split("=", 1) for p in request.headers.get("Doitong-Signature", "").split(",") if "=" in p)
    t = parts.get("t", "0")
    expected = hmac.new(SECRET, t.encode() + b"." + body, hashlib.sha256).hexdigest()
    if not hmac.compare_digest(expected, parts.get("v1", "")) or abs(time.time() - int(t)) > 300:
        abort(400)

    event = json.loads(body)
    if event["type"] == "request.succeeded":
        print(event["data"]["id"], [o["url"] for o in event["data"]["outputs"]])
    return "", 204
```

## 提示

> [!TIP]
> Webhook 是一种便利功能，而不是事实来源：如果漏掉某个事件，`GET /requests/{id}` 始终包含最终状态。

- 快速响应，并将自己的处理任务加入队列。
- 签名密钥属于启动运行的 API 密钥。不同服务中的密钥具有不同的签名密钥。