# Webhook

Daripada melakukan tinjauan berkala, berikan `webhook_url` kepada sesuatu run. Apabila permintaan mencapai status akhir (`succeeded`, `failed` atau
`canceled`), kami menghantar `POST` yang ditandatangani ke URL tersebut.

```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 mestilah `https://` awam. Alamat peribadi, tempatan dan bukan HTTPS ditolak dengan
> `422 invalid_webhook_url` sebelum apa-apa caj dikenakan.

## Peristiwa

```http Pengepala permintaan
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 Isi permintaan
{
  "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` ialah `request.succeeded`, `request.failed` atau `request.canceled`.
- `data` ialah objek permintaan penuh, tepat seperti yang dikembalikan oleh `GET /requests/{id}`.
- `id` kekal sama untuk sesuatu permintaan dan status akhirnya. Gunakannya untuk mengabaikan penghantaran yang telah anda proses.

## Penghantaran dan percubaan semula

Balas dengan sebarang status `2xx` dalam masa 10 saat. Apa-apa yang lain (atau tamat masa) akan dicuba semula: sehingga 6 percubaan keseluruhannya,
selepas 30 saat, 2 minit, 10 minit, 1 jam dan 6 jam. Lakukan kerja yang mengambil masa selepas anda membalas, bukan sebelumnya.

## Sahkan tandatangan

Setiap kunci mempunyai rahsia tandatangan tersendiri. Baca rahsia itu sekali daripada `GET https://api.doitong.com/v1/account` (`webhook_signing_secret`,
ia bermula dengan `whsec_`) dan simpan bersama kunci tersebut.

Pengepala `Doitong-Signature` ialah `t=<unix time>,v1=<signature>`, dengan tandatangan tersebut ialah
HMAC-SHA256 heks bagi `"<t>.<raw request body>"` menggunakan rahsia anda sebagai kunci. Untuk mengesahkan:

1. Ambil bait isi permintaan mentah tepat seperti yang diterima (sebelum sebarang penghuraian JSON).
2. Kira HMAC-SHA256 bagi `t + "." + body` menggunakan rahsia anda, sebagai heks huruf kecil.
3. Bandingkan dengan `v1` dalam masa malar.
4. Tolak peristiwa apabila `t` berbeza lebih daripada 5 minit daripada jam anda (perlindungan daripada serangan ulangan).

Penerima lengkap dalam Node.js (Express) dan 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
```

## Petua

> [!TIP]
> Webhook ialah kemudahan, bukan sumber kebenaran: jika anda terlepas satu, `GET /requests/{id}` sentiasa mempunyai
> keadaan akhir.

- Balas dengan pantas dan masukkan pemprosesan anda sendiri ke dalam baris gilir.
- Rahsia itu adalah milik kunci API yang memulakan run. Kunci dalam perkhidmatan yang berbeza mempunyai rahsia yang berbeza.