Webhooks

Webhooks

Mit Webhooks empfängst du Echtzeit-Benachrichtigungen, wenn Events in deinem Workspace auftreten — z.B. wenn ein QR-Code gescannt wird.

Webhook erstellen

POST /v1/webhooks

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

Achtung

Webhook-URLs müssen HTTPS verwenden. HTTP-URLs werden abgelehnt.

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"
}

Hinweis

Das secret wird nur einmal zurückgegeben. Bewahre es sicher auf — es wird für die Signaturverifikation benötigt.

Event-Typen

Event	Beschreibung
*	Alle Events
qr.created	QR-Code erstellt
qr.updated	QR-Code aktualisiert (URL, Status, Tags)
qr.deleted	QR-Code gelöscht
qr.scanned	QR-Code gescannt
qr.flagged	QR-Code als unsicher markiert
webhook.ping	Test-Ping (via /ping-Endpoint)

Hinweis

Webhooks sind ab dem Pro-Tarif enthalten. qr.scanned meldet Scans deiner Codes und Aufrufe eines Digitalen Produktpasses über den Resolver; bei einem DPP stehen dpp_id, gtin, serial und lot statt code_id und short_code in data. Die Nutzdaten enthalten keine IP-Adresse.

Payload-Format

Alle Webhook-Payloads haben dieses Format:

{
  "id": "evt_4f0c2a91d7e84b3c9a1f",
  "type": "qr.scanned",
  "created": "2026-03-15T10:00:00.000Z",
  "data": {
    "code_id": "qr_abc123",
    "short_code": "r7f3Kx",
    "scanned_at": "2026-03-15T10:00:00.000Z",
    "country": "AT",
    "device_type": "mobile",
    "os": "iOS",
    "browser": "Safari",
    "language": "de",
    "ab_variant": null,
    "redirected_to": "https://example.com/landing"
  }
}

Code-Events: qr.created und qr.updated

Bei diesen beiden Events ist data der Code genau so, wie GET /v1/codes/:id ihn liefert. Dazu gehört appearance, die am Code gespeicherten Farben (null steht für das Standard-Schwarz bzw. -Weiß):

{
  "id": "evt_9b2e41c07a5d4f18b3c6",
  "type": "qr.updated",
  "created": "2026-09-28T10:00:00.000Z",
  "data": {
    "id": "qr_abc123",
    "short_code": "r7f3Kx",
    "status": "live",
    "appearance": { "foreground_color": "#1F4E79", "background_color": null },
    "updated_at": "2026-09-28T10:00:00.000Z"
  }
}

Das Beispiel ist gekürzt. Alle Felder stehen in der Codes-API.

Signaturverifikation

qr3.app signiert jeden Webhook-Request mit HMAC-SHA256:

X-QR3-Signature: sha256=a1b2c3d4e5f6...
X-QR3-Event: qr.scanned
X-QR3-Delivery: wdl_abc123
X-QR3-Attempt: 1
User-Agent: qr3-webhooks/1.0

Verifikation implementieren

Node.js

import crypto from "crypto";

function verifySignature(
  payload: string,
  signature: string | undefined,
  secret: string
): boolean {
  const expected = crypto
    .createHmac("sha256", secret)
    .update(payload)
    .digest("hex");
  const expectedBytes = Buffer.from(`sha256=${expected}`);
  const receivedBytes = Buffer.from(signature ?? "");
  return (
    expectedBytes.length === receivedBytes.length &&
    crypto.timingSafeEqual(expectedBytes, receivedBytes)
  );
}

// In Express: verify the raw body — re-serialised JSON breaks the signature.
app.post(
  "/webhooks/qr3",
  express.raw({ type: "application/json" }),
  (req, res) => {
    const raw = req.body.toString("utf8");
    const signature = req.headers["x-qr3-signature"] as string | undefined;
    if (!verifySignature(raw, signature, process.env.QR3_WEBHOOK_SECRET!)) {
      return res.status(401).json({ error: "Invalid signature" });
    }
    const event = JSON.parse(raw);
    console.log(event.type, event.data);
    res.json({ received: true });
  },
);

Python

import hmac
import hashlib

def verify_signature(payload: str, signature: str, secret: str) -> bool:
    expected = hmac.new(
        secret.encode(),
        payload.encode(),
        hashlib.sha256
    ).hexdigest()
    received = (signature or "").removeprefix("sha256=")
    return hmac.compare_digest(expected, received)

Retry-Logik

Bei Fehlern (HTTP >= 300 oder Timeout) versucht qr3.app die Zustellung erneut:

Versuch	Delay
1	Sofort
2	1 Minute
3	5 Minuten

Nach 10 aufeinanderfolgenden Fehlern wird der Webhook automatisch deaktiviert.

Delivery-Logs

GET /v1/webhooks/:id/deliveries

{
  "data": [
    {
      "id": "wdl_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

Teste einen Webhook sofort:

POST /v1/webhooks/:id/ping

Das sendet einen webhook.ping-Event an deine Endpoint-URL.