Mosaqo webhooks

Мы отправляем POST с подписанным JSON на ваш endpoint для каждого события, на которое вы подписаны, и повторяем с нарастающей задержкой, пока вы его не примете.

Подписка

Либо добавьте endpoint в разделе Bulk & API, либо зарегистрируйте его из своего кода ключом со скоупом webhooks:write — именно так платформы автоматизации включают и выключают триггер:

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

В ответе будет secret для подписи. Его показывают только один раз — сохраните его или позже замените подписку.

События

Payload

Когда событие касается QR-кода, data.qr содержит ту же карточку, которую возвращает GET /qr/{id}, — поэтому триггеру не нужно отдельно запрашивать запись, о которой ему только что сообщили.

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

Проверка доставки

Каждый запрос несёт метку времени и подпись сразу над меткой и телом:

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

Именно отбрасывание всего, чья метка далека от ваших часов, делает перехваченную доставку невоспроизводимой — не пропускайте эту проверку. Сравнивайте подписи за постоянное время и берите сырое тело запроса: повторная сериализация разобранного JSON меняет байты, и подпись перестанет совпадать.

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"])

Повторы и сбои

Отвечайте любым 2xx, как только сохранили событие, а работу делайте после. Мы повторяем до шести раз с нарастающей задержкой, поэтому медленный обработчик оборачивается дублями доставок — считайте X-Mosaqo-Delivery ключом идемпотентности на своей стороне.

Endpoint должен быть HTTPS на публичном хосте. Локальные и приватные адреса отклоняются ещё при создании подписки.

Устаревшая подпись

X-Mosaqo-Signature-V0 несёт более раннюю подпись, вычисленную только над телом. Она не способна выразить защиту от повтора, едет ещё один релиз, чтобы существующие получатели мигрировали, и не должна использоваться ни в чём новом.

Данные сканирований не выталкиваются

Вебхука на отдельное сканирование намеренно нет. Mosaqo не отправляет аналитику уровня сканирований на сторонние endpoint-ы, и ни одно событие из таблицы выше её не несёт.

История сканирований доступна только если вы сами её забираете своим ключом — GET /scans, — и даже тогда ею управляют настройки приватности аналитики вашего пространства: отключённые измерения не попадают ни в одну строку, фильтр ботов действует, а псевдонимный хеш посетителя, на котором строятся «уникальные сканирования», не отдаётся никогда. В ответе есть allowedDimensions, чтобы вы знали, что именно получаете.

scan.aggregate_ready сообщает, что сводка готова; самих сканирований оно не содержит. Если вашей интеграции действительно нужны отдельные сканирования в реальном времени — это доступно по отдельному запросу, так что напишите нам, а не предполагайте, что оно уже есть.

Если вы не можете принимать webhooks

Опрашивайте. GET /qr?updatedSince=… даёт изменённые коды, а GET /scans?since=… проходит историю сканирований вперёд со стабильным курсором.