Webhooky Mosaqo

Na váš endpoint posíláme POST s podepsaným JSONem pro každou odebíranou událost a opakujeme s rostoucím odstupem, dokud ji nepřijmete.

Odběr

Buď přidejte endpoint v sekci Bulk & API, nebo si ho zaregistrujte z vlastního kódu klíčem s rozsahem webhooks:write — přesně takhle automatizační platforma zapíná a vypíná spouštěč:

curl -X POST https://api.mosaqo.app/v1/public-api/webhooks \
  -H "Authorization: Bearer $MOSAQO_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/mosaqo",
    "eventTypes": ["qr.published", "qr.updated"]
  }'

Odpověď obsahuje secret pro podpis. Ukážeme ho jen jednou — uložte si ho, nebo odběr později nahraďte.

Události

Payload

Když se událost týká QR kódu, data.qr nese stejný souhrn, jaký vrací GET /qr/{id} — spouštěč se tedy nemusí doptávat na záznam, o kterém mu právě řekli.

{
  "id": "0b0f…",
  "type": "qr.published",
  "workspaceId": "2f60…",
  "occurredAt": "2026-08-05T10:20:30.456Z",
  "data": {
    "qrId": "e7b7…",
    "source": "public_api",
    "qr": {
      "id": "e7b7…",
      "name": "Autumn campaign",
      "slug": "autumn-campaign-1a2b3c4d",
      "mode": "dynamic",
      "contentType": "url",
      "status": "published",
      "approvalState": "not_required",
      "folderId": null,
      "updatedAt": "2026-08-05T10:20:30.401Z",
      "publicUrl": "https://mosaqo.link/aB3dEf"
    }
  }
}

Ověření doručení

Každý požadavek nese časové razítko a podpis nad razítkem i tělem zároveň:

X-Mosaqo-Timestamp: 1785942718
X-Mosaqo-Signature: t=1785942718,v1=<hex HMAC-SHA256 of "{timestamp}.{raw body}">
X-Mosaqo-Delivery: 0b0f…
X-Mosaqo-Event: qr.published

Odmítat vše, jehož razítko je daleko od vašich hodin, je přesně to, co dělá zachycené doručení neopakovatelným — tuhle kontrolu nevynechávejte. Porovnávejte podpisy v konstantním čase a používejte surové tělo požadavku: opětovná serializace rozparsovaného JSONu změní bajty a podpis přestane sedět.

Node.js

import { createHmac, timingSafeEqual } from 'node:crypto';

export function verifyMosaqoWebhook(rawBody, header, secret, toleranceSeconds = 300) {
  const parts = Object.fromEntries(
    header.split(',').map((piece) => piece.split('=').map((s) => s.trim())),
  );
  const timestamp = Number(parts.t);
  if (!Number.isFinite(timestamp)) return false;
  if (Math.abs(Date.now() / 1000 - timestamp) > toleranceSeconds) return false;

  const expected = createHmac('sha256', secret)
    .update(`${parts.t}.${rawBody}`)
    .digest();
  const received = Buffer.from(parts.v1 ?? '', 'hex');
  return expected.length === received.length && timingSafeEqual(expected, received);
}

PHP

<?php
function verify_mosaqo_webhook(string $rawBody, string $header, string $secret, int $tolerance = 300): bool {
    $parts = [];
    foreach (explode(',', $header) as $piece) {
        [$key, $value] = array_map('trim', explode('=', $piece, 2));
        $parts[$key] = $value;
    }
    if (!isset($parts['t'], $parts['v1'])) return false;
    if (abs(time() - (int) $parts['t']) > $tolerance) return false;

    $expected = hash_hmac('sha256', $parts['t'] . '.' . $rawBody, $secret);
    return hash_equals($expected, $parts['v1']);
}

Python

import hmac, time
from hashlib import sha256

def verify_mosaqo_webhook(raw_body: bytes, header: str, secret: str, tolerance: int = 300) -> bool:
    parts = dict(piece.strip().split("=", 1) for piece in header.split(","))
    if "t" not in parts or "v1" not in parts:
        return False
    if abs(time.time() - int(parts["t"])) > tolerance:
        return False

    signed = f"{parts['t']}.".encode() + raw_body
    expected = hmac.new(secret.encode(), signed, sha256).hexdigest()
    return hmac.compare_digest(expected, parts["v1"])

Opakování a selhání

Odpovězte libovolným 2xx, jakmile událost uložíte; práci udělejte potom. Opakujeme až šestkrát s exponenciálně rostoucím odstupem, takže pomalý handler se změní ve zdvojená doručení — berte X-Mosaqo-Delivery na své straně jako klíč idempotence.

Endpointy musí být na HTTPS a veřejném hostiteli. Lokální a privátní adresy odmítáme už při vytvoření odběru.

Zastaralý podpis

X-Mosaqo-Signature-V0 nese starší podpis počítaný jen z těla. Ochranu proti opakování vyjádřit neumí, jede ještě jedno vydání, aby stávající příjemci stihli přejít, a pro nic nového se používat nemá.

Data o skenování neposíláme ven

Záměrně neexistuje webhook na jednotlivé skenování. Mosaqo neposílá analytiku na úrovni skenování na endpointy třetích stran a žádná událost z tabulky výše ji nenese.

Historie skenování je dostupná jen tak, že si ji stáhnete sami vlastním klíčem — GET /scans — a i tehdy jí vládne nastavení soukromí analytiky vašeho prostoru: dimenze, které jste vypnuli, v žádném řádku nejsou, filtr botů platí a pseudonymní hash návštěvníka stojící za „unikátními skenováními“ se nikdy nezveřejňuje. Odpověď vypisuje allowedDimensions, abyste věděli, co dostáváte.

scan.aggregate_ready říká, že agregát je hotový; samotná skenování v něm nejsou. Pokud vaše integrace opravdu potřebuje jednotlivá skenování v reálném čase, je to dostupné na vyžádání — ozvěte se nám, místo abyste s tím počítali.

Když webhooky přijímat nemůžete

Ptejte se sami. GET /qr?updatedSince=… vrací změněné kódy a GET /scans?since=… prochází historii skenování dopředu se stabilním kurzorem.