Webhooks

Der Veranstaltungskatalog

Fragen Sie API, welche Ereignisse Sie abonnieren können. Der Katalog basiert auf der zentralen Quelle für Live-Automatisierungsauslöser und listet daher nur Ereignisse auf, die heute tatsächlich ausgelöst werden – gruppiert nach Lebenszyklusphase (Akquise, Engagement, Loyalität, Kundenbindung, Handel, Empfehlung) – jeweils mit Ereignisschlüssel, Beschreibung und Beispielnutzlast. Die Antwort dokumentiert außerdem den gemeinsamen Nutzlast-Envelope und die Signatur-Header.

curl https://flash.socialhub.ai/api/v2/events/catalog \
  -H "Authorization: Bearer fl_live_..."

# { "data": { "events": [
#     { "event": "member.created", "label": "Member created",
#       "stage": "acquisition", "examplePayload": { ... } },
#     { "event": "loyalty.tier_upgraded", "label": "Tier upgraded",
#       "stage": "loyalty", "examplePayload": { ... } },
#     ...
#   ],
#   "payload": { "schema": { ... }, "headers": { ... } }
# } }

Setzen Sie beim Abonnieren den event-Schlüssel eines Ereignisses direkt in den eventTypes array. Erfordert den webhooks:manage-Bereich.

Jede Signatur prüfen

Flash signiert jede Zustellung mit dem whsec_-Geheimnis Ihres Endpunkts mithilfe von Standard-Webhooks (HMAC-SHA256). Die Signatur wird anhand von {webhook-id}.{webhook-timestamp}.{body} neu berechnet und in konstanter Zeit mit dem webhook-signature-Header verglichen. Alle nicht übereinstimmenden Daten sowie webhook-timestamp-Daten, die zu alt sind, um Replay-Angriffe zu verhindern, werden verworfen. Der Signaturschlüssel besteht gemäß Spezifikation aus den Base64-dekodierten Bytes des Geheimnisses nach dem whsec_-Präfix. Bei einer Geheimnisrotation enthält der Header mehrere durch Leerzeichen getrennte v1,…-Werte – die Zustellung wird akzeptiert, wenn einer übereinstimmt.

import crypto from "node:crypto";

// req.body must be the RAW, unparsed request body string.
function verifyFlashWebhook(headers, rawBody, whsec) {
  const id = headers["webhook-id"];
  const ts = headers["webhook-timestamp"];
  const sigHeader = headers["webhook-signature"]; // "v1,<b64> v1,<b64> ..."

  // reject stale deliveries (5 min tolerance)
  if (Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false;

  const key = Buffer.from(whsec.replace(/^whsec_/, ""), "base64");
  const expected = crypto
    .createHmac("sha256", key)
    .update(`${id}.${ts}.${rawBody}`)
    .digest("base64");

  return sigHeader
    .split(" ")
    .map((p) => p.split(",")[1])
    .some((sig) =>
      sig &&
      sig.length === expected.length &&
      crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)),
    );
}