Gå til indhold

Webhooks

Webhooks

Med webhooks modtager du realtidsnotifikationer, når der sker hændelser i dit workspace — f.eks. når en QR-kode scannes.

Opret webhook

Terminal window
POST /v1/webhooks
{
"url": "https://example.com/webhooks/qr3",
"events": ["qr.scanned", "qr.created"],
"secret": "my-secret-key-min-16-chars"
}

Response

{
"id": "wh_abc123",
"url": "https://example.com/webhooks/qr3",
"events": ["qr.scanned", "qr.created"],
"is_active": true,
"secret": "my-secret-key-min-16-chars",
"secret_hint": "my-s…",
"created_at": "2026-03-15T10:00:00.000Z"
}

Eventtyper

EventBeskrivelse
*Alle events
qr.createdQR-kode oprettet
qr.updatedQR-kode opdateret (URL, status, tags)
qr.deletedQR-kode slettet
qr.scannedQR-kode scannet
qr.flaggedQR-kode markeret som usikker
scan.createdScanningshændelse (alias for qr.scanned)
workspace.updatedWorkspace opdateret
webhook.pingTest-ping (via /ping-endpoint)

Payload-format

Alle webhook-payloads har dette format:

{
"id": "evt_abc123xyz",
"type": "qr.scanned",
"created": "2026-03-15T10:00:00.000Z",
"data": {
"code_id": "qr_abc123",
"short_code": "r7f3Kx",
"scan_id": "scn_xyz",
"country": "AT",
"device_type": "mobile",
"os": "iOS"
}
}

Signaturverifikation

qr3.app signerer hver webhook-anmodning med HMAC-SHA256:

X-QR3-Signature: sha256=a1b2c3d4e5f6...

Implementer verifikation

import crypto from "crypto";
function verifySignature(
payload: string,
signature: string,
secret: string
): boolean {
const expected = crypto
.createHmac("sha256", secret)
.update(payload)
.digest("hex");
const received = signature.replace("sha256=", "");
return crypto.timingSafeEqual(
Buffer.from(expected, "hex"),
Buffer.from(received, "hex")
);
}
// In Express:
app.post("/webhooks/qr3", (req, res) => {
const signature = req.headers["x-qr3-signature"] as string;
const valid = verifySignature(
JSON.stringify(req.body),
signature,
process.env.QR3_WEBHOOK_SECRET
);
if (!valid) return res.status(401).json({ error: "Invalid signature" });
const event = req.body;
console.log(event.type, event.data);
res.json({ received: true });
});

Retry-logik

Ved fejl (HTTP >= 300 eller timeout) forsøger qr3.app at levere igen:

ForsøgForsinkelse
1Med det samme
21 minut
35 minutter

Efter 10 fejl i træk deaktiveres webhooken automatisk.

Delivery-logs

Terminal window
GET /v1/webhooks/:id/deliveries
{
"data": [
{
"id": "whd_abc123",
"event_type": "qr.scanned",
"status": "success",
"status_code": 200,
"response_time_ms": 145,
"attempt": 1,
"created_at": "2026-03-15T10:00:00.000Z"
}
]
}

Test-ping

Test en webhook med det samme:

Terminal window
POST /v1/webhooks/:id/ping

Dette sender en webhook.ping-event til din endpoint-URL.