# Webhooks

Minflok tagħmel polling, agħti `webhook_url` lil run. Meta t-talba tasal għal status finali (`succeeded`, `failed` jew
`canceled`), nibagħtu `POST` iffirmat lil dak l-URL.

```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]
> L-URL irid ikun pubbliku `https://`. Indirizzi privati, lokali u mhux HTTPS jiġu rrifjutati b’
> `422 invalid_webhook_url` qabel ma jiġi ċċarġjat xejn.

## L-avveniment

```http Headers tat-talba
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 Body tat-talba
{
  "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` huwa `request.succeeded`, `request.failed` jew `request.canceled`.
- `data` huwa l-oġġett sħiħ tat-talba, eżattament dak li jirritorna `GET /requests/{id}`.
- `id` huwa stabbli għal talba u għall-istatus finali tagħha. Użah biex tinjora kunsinna li diġà pproċessajt.

## Kunsinni u tentattivi mill-ġdid

Irrispondi bi kwalunkwe status `2xx` fi żmien 10 sekondi. Kull ħaġa oħra (jew timeout) terġa’ tiġi ppruvata: sa 6 tentattivi b’kollox,
wara 30 sekonda, 2 minuti, 10 minuti, siegħa u 6 sigħat. Agħmel ix-xogħol bil-mod wara li tirrispondi, mhux qabel.

## Ivverifika l-firma

Kull ċavetta għandha sigriet tal-iffirmar tagħha. Aqrah darba minn `GET https://api.doitong.com/v1/account` (`webhook_signing_secret`,
jibda b’`whsec_`) u aħżnu ħdejn iċ-ċavetta.

Il-header `Doitong-Signature` huwa `t=<unix time>,v1=<signature>`, fejn il-firma hija l-
HMAC-SHA256 hex ta’ `"<t>.<raw request body>"` bis-sigriet tiegħek bħala ċ-ċavetta. Biex tivverifika:

1. Ħu l-bytes tal-body mhux ipproċessat eżattament kif waslu (qabel kwalunkwe parsing ta’ JSON).
2. Ikkalkula HMAC-SHA256 ta’ `t + "." + body` bis-sigriet tiegħek, bħala hex b’ittri żgħar.
3. Qabblu ma’ `v1` f’ħin kostanti.
4. Irrifjuta l-avveniment meta `t` ikun aktar minn 5 minuti ’l bogħod mill-arloġġ tiegħek (protezzjoni kontra replay).

Riċevitur sħiħ f’Node.js (Express) u 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
```

## Suġġerimenti

> [!TIP]
> Il-Webhooks huma konvenjenza, mhux is-sors ewlieni tal-verità: jekk titlef wieħed, `GET /requests/{id}` dejjem ikollu l-
> istat finali.

- Irrispondi malajr u poġġi l-ipproċessar tiegħek fil-kju.
- Is-sigriet jappartjeni għall-API key li bdiet ir-run. Ċwievet f’servizzi differenti għandhom sigrieti differenti.