Webhooks

Utvecklardokumentation: alla sidor

Börja

Hjälp och dokumentation

Ändringar

01Prenumerera

Öppna Utvecklare i Supplier Admin eller Retailer Admin och lägg till HTTPS-adressen och händelserna. Spara signeringshemligheten med prefixet whsec_ när den visas; den visas bara en gång. Samma sida listar leveranser och skickar ett test.

02Händelser

HändelseFörNär
stock.updatedÅterförsäljareEn lagerrad ändrades; stockId och updatedAt.
stock.updated.v2ÅterförsäljareSamma ändring med evidensnivå, källa och observationstid.
stock.confirmedÅterförsäljareEn person bekräftade lagret utan att ändra det.
lead.createdVarumärkenEn kund reserverade en produkt.
import.completedVarumärkenEn import nådde ett slutligt utfall.

Innehållet har id:n och tider, inga personuppgifter. Läs detaljer via API:et. Lageruppdateringar levererar senaste tillståndet; bekräftelser slås inte ihop.

03Kontrollera signaturen

Läs X-Stockisto-Event, X-Stockisto-Delivery-Id och X-Stockisto-Signature. Signaturhuvudet är t=<unixSeconds>,v1=<hexHmac>. Kontrollera HMAC-SHA256 över tidsstämpeln, en punkt och den råa anropskroppen. Serialisera aldrig om tolkad JSON.

Godta valfri matchande v1 vid byte av hemlighet, ignorera okända taggar och avvisa tidsstämplar mer än 5 minuter bort. Ge denna Node.js-funktion den oförändrade kroppen som Buffer eller UTF-8-sträng. Svara med 2xx först när händelsen har accepterats; deduplicera med leverans-id.

X-Stockisto-Event: lead.created
X-Stockisto-Delivery-Id: DELIVERY_ID
X-Stockisto-Signature: t=1791374400,v1=SIGNATURE
Node.js
const crypto = require("node:crypto");

function verify(header, rawBody, secret) {
    const pairs = String(header)
        .split(",")
        .map((p) => p.trim().split("="));
    const timestamps = pairs.filter(([k]) => k === "t");
    if (timestamps.length !== 1) return false;
    const t = timestamps[0][1];
    if (!/^\d+$/.test(t) || Math.abs(Date.now() / 1000 - Number(t)) > 300)
        return false;
    const want = crypto
        .createHmac("sha256", secret)
        .update(t + ".")
        .update(rawBody)
        .digest();
    return pairs.some(
        ([k, v]) =>
            k === "v1" &&
            /^[0-9a-f]{64}$/.test(v) &&
            crypto.timingSafeEqual(Buffer.from(v, "hex"), want),
    );
}

04Nya försök

En leverans får högst 5 försök, med nya försök efter 1, 5, 30 och 120 minuter. Läs leveransloggen under Utvecklare. En blockerad adress kan avvisas utan fler försök.

05Byt hemlighet

  1. Välj Rotera och spara den nya hemligheten och när den gamla slutar gälla.
  2. Båda hemligheterna signerar i 7 dagar. Byt till den nya under den tiden.
  3. Efter 7 dagar signerar bara den nya. Ett nytt signaturschema lägger till en tagg som v2; det gamla finns kvar minst 90 dagar.