Webhooki

Zdarzenia

Subskrybuj, publikując channels.webhooks[] w konfiguracji sklepu (id, url i events). URL musi być publicznym https; adresy prywatne, loopback i wewnętrzne są odrzucane przy zapisie konfiguracji i ponownie przy wysyłce.

Treść

Treść to kanoniczny JSON (RFC 8785), identyczny bajt w bajt przy każdej próbie. data.order to pełny podpisany dokument order.v1; data.fromStatus istnieje tylko w order.status_changed.

{
  "createdAt": "2026-10-19T09:30:00.000Z",
  "data": {
    "fromStatus": "received",
    "order": {
      "…": "order.v1"
    },
    "orderId": "<order id>",
    "status": "confirmed"
  },
  "id": "<event id>",
  "schemaVersion": 1,
  "tenantId": "<tenant id>",
  "type": "order.status_changed"
}

Nagłówki

Każda dostawa niesie pięć nagłówków. Deduplikuj po CutOptim-Event-Id: ponowienie i ponowne wysłanie go powtarzają, a CutOptim-Delivery-Id jest inny.

Weryfikacja podpisu

Podpis ma postać t=<unix seconds>,v1=<hex HMAC-SHA256(secret, "<t>.<raw body>")>. Przyjmij dostawę, gdy dowolna wartość v1 pasuje do jednego z Twoich sekretów, a t mieści się w 300 sekundach od Twojego zegara; porównuj w stałym czasie. Weryfikuj surowe bajty, zanim je sparsujesz: framework, który parsuje i ponownie serializuje treść, zmienia ją i każda kontrola się nie powiedzie.

Dwa poniższe odbiorniki to przykłady referencyjne, bez zmian: Node 18+ wyłącznie z node:crypto oraz PHP 7.4+ bez Composera. Oba czytają sekret z CUTOPTIM_WEBHOOK_SIGNING.

configurator/adapters/reference/node/example-server.mjs

// example-server.mjs - a webhook endpoint on node:http, to read and adapt.   CUTOPTIM_WEBHOOK_SIGNING=whsec_... node example-server.mjs
// (whsec_REPLACE_ME is a placeholder: the real secret comes from the CutOptim admin route.)
import { createServer } from 'node:http';
import { createWebhookReceiver } from './cutoptim-verify.mjs';

const secret = process.env.CUTOPTIM_WEBHOOK_SIGNING;
if (!secret) { console.error('set CUTOPTIM_WEBHOOK_SIGNING (whsec_REPLACE_ME is a placeholder)'); process.exit(1); }

const receive = createWebhookReceiver({
  secrets: [secret],
  async onEvent(event) {
    // event.type === 'order.created'; event.data.order is the signed order document. Store it in YOUR order table here,
    // keyed by event.data.orderId, in the same transaction that records the event id as seen.
    console.log('order.created', event.data.orderId);
  },
});

createServer(async (req, res) => {
  if (req.method !== 'POST') { res.writeHead(405).end(); return; }
  const chunks = []; let size = 0;
  for await (const c of req) { size += c.length; if (size > 2_000_000) { res.writeHead(413).end(); return; } chunks.push(c); }
  const out = await receive({ rawBody: Buffer.concat(chunks), headers: req.headers });   // the RAW bytes, not parsed JSON
  res.writeHead(out.status, { 'Content-Type': 'application/json' }).end(JSON.stringify({ result: out.reason }));
}).listen(Number(process.env.PORT ?? 8787));

configurator/adapters/reference/php/example-webhook.php

<?php
/**
 * example-webhook.php - a webhook endpoint in plain PHP, to read and adapt.
 * CUTOPTIM_WEBHOOK_SIGNING=whsec_... is read from the environment (whsec_REPLACE_ME is a placeholder; the real secret comes from the
 * CutOptim admin route). Replace MemorySeen with a table that has a UNIQUE key on the event id.
 */
require __DIR__ . '/CutOptimVerify.php';

use CutOptim\CutOptimVerify;
use CutOptim\MemorySeen;

$secret = getenv('CUTOPTIM_WEBHOOK_SIGNING');
if ($secret === false || $secret === '') {
    http_response_code(500);
    exit('CUTOPTIM_WEBHOOK_SIGNING is not set');
}

$rawBody = file_get_contents('php://input');   // the RAW bytes, not decoded JSON
$headers = function_exists('getallheaders') ? getallheaders() : [];
$out = CutOptimVerify::handleWebhook($rawBody, $headers, [$secret], new MemorySeen(), static function (array $event): void {
    // $event['type'] === 'order.created'; $event['data']['order'] is the signed order document. Store it in YOUR order table
    // keyed by $event['data']['orderId'], in the same transaction that records the event id as seen.
});

http_response_code($out['status']);
header('Content-Type: application/json');
echo json_encode(['result' => $out['reason']]);

Ponowienia, dead letters i ponowne wysłanie

Odpowiedź inna niż 2xx, przekroczenie czasu i przekierowanie to nieudane próby. Dostawa jest próbowana łącznie 6 razy, z rosnącymi odstępami; po ostatniej porażce staje się dead letter. URL, który rozwiązuje się na adres prywatny, jest dead letter od razu. Twój serwer może odczytać log dostaw i poprosić o ponowne wysłanie kluczem tajnym (/cfg/v1/admin/deliveries); ponowne wysłanie zachowuje identyfikator zdarzenia.

Zamówienia testowe

Zamówienie złożone kluczem testowym nie kolejkuje ani webhooka, ani e-maila: Twój ERP i Twoi kupujący nigdy nie widzą ruchu testowego.